This API will not be available until SSP v2.0
Get Plan (MAP) Summary
Description
Paginated collection of all plan summaries for {person-uuid}, optionally filtered by status. See API notes for status parameter handling handling.
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/summary
Security
PERSON_MAP_READ
Parameters
status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
Returns
{
"success":"true",
"results":1,
"rows":[
{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate":1331269200000,
"createdBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"modifiedDate":1331269200000,
"modifiedBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"objectStatus":"ACTIVE",
"personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
"ownerId": "da572870-5699-11e2-be1e-406c8f22c3ce",
"contactTitle":"Ms.",
"contactName":"Joan James",
"contactPhone":"(212) 555-1234",
"contactEmail":"john.james@hkjhfe.com",
"contactNotes":"Call before Noon",
"name":"John Doe's Path To Success",
"isOnPlan":false,
"studentNotes":"Summer classes may help complete the program quicker",
"academicGoals":"Graduate from a 4 year university",
"offPlanReason":"John had to pick up extra hours at work.",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":false,
"careerLink":"http://www.careers.com/dental_hygenist",
"academicLink":"http://www.academics.com/dental_hygenist_classes"
}
]
}
Get All Plan (MAP)
Description
Paginated collection of all plan details for {person-uuid}, optionally filtered by status. See API notes for status parameter handling handling.
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/
Security
PERSON_MAP_READ
Parameters
status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
Returns
{
"success":"true",
"results":1,
"rows":[
{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"createdDate":1331269200000,
"createdBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"modifiedDate":1331269200000,
"modifiedBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"objectStatus":"ACTIVE",
"personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
"ownerId": "da572870-5699-11e2-be1e-406c8f22c3ce",
"contactTitle":"Ms.",
"contactName":"Joan James",
"contactPhone":"(212) 555-1234",
"contactEmail":"john.james@hkjhfe.com",
"contactNotes":"Call before Noon",
"name":"John Doe's Path To Success",
"isOnPlan":false,
"studentNotes":"Summer classes may help complete the program quicker",
"academicGoals":"Graduate from a 4 year university",
"offPlanReason":"John had to pick up extra hours at work.",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":false,
"careerLink":"http://www.careers.com/dental_hygenist",
"academicLink":"http://www.academics.com/dental_hygenist_classes",
"planCourses":[
{
"id":"ce0d041d-d3ac-42a1-9085-7f744240e07e",
"createdDate":1331269200000,
"createdBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"modifiedDate":1331269200000,
"modifiedBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"objectStatus":"ACTIVE",
"personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
"courseCode":"BIO128_12345"
"formattedCourse":"BIO128",
"courseTitle":"Cell Biology",
"courseDescription":"Cell Biology Description",
"orderInTerm":1,
"creditHours":5,
"isTranscript":true,
"studentNotes":"This class can be difficult if you haven't taken BIO in HS",
"contactNotes":"Advise student to brush up on HS BIO",
"isImportant":true,
"isDev":true,
"electiveIds":[ {"id":"1d93a1b5-a2d9-11e2-8d55-406c8f22c3ce"},
{"id":"2b69aff5-a2d9-11e2-a881-406c8f22c3ce") ],
"termCode":"FA-13"
}
],
"termNotes":[
{
"id":"ce0d041d-d3ac-42a1-9085-7f744240e07e",
"createdDate":1331269200000,
"createdBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"modifiedDate":1331269200000,
"modifiedBy":{
"id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName":"John",
"lastName":"Doe"
},
"objectStatus":"ACTIVE"
"isImportant":false,
"termCode":"FA-13",
"studentNotes":"John is also working full time this semester",
"contactNotes":"John is at risk because of outside commitments"
}
]
}
]
}
Get Plan (MAP) Current
Description
Display of the active plan details for {person-uuid}, optionally filtered by status. See API notes for status parameter handling handling.
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/current
Security
PERSON_MAP_READ
Returns
{
"id":"0a90940a-3fc7-1f00-813f-ca10fee70002",
"createdDate":1373484678888,
"createdBy":{
"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"
},
"modifiedDate":1373484778372,
"modifiedBy":{
"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"
},
"objectStatus":"ACTIVE",
"name":"Sample Plan",
"ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b",
"ownerName":"Amy Administrator",
"contactTitle":"Advisor",
"contactName":"John Smith",
"contactPhone":"212-555-1212",
"contactEmail":"advisor@college.edu",
"contactNotes":"Advisor Plan Notes",
"studentNotes":"Student Plan Notes",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":true,
"academicGoals":"Goals for Academics",
"academicLink":"http://www.college.edu/academic.html",
"careerLink":"http://www.college.edu/career.html",
"isValid":true,
"termNotes":[
{
"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"
},
"objectStatus":"ACTIVE",
"studentNotes":"Student Term Notes",
"contactNotes":"Advisor Term Notes",
"termCode":"FA2013",
"isImportant":true},
"planCourses":[
{
"id":"0a90940a-3fc7-1f00-813f-ca1283680016",
"createdDate":1373484778344,
"createdBy":{
"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1373484778344,
"modifiedBy":{
"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"termCode":"FA2013",
"courseCode":"IEE-105",
"formattedCourse":"IEE105",
"courseTitle":"Analytical Industrial Engineering",
"courseDescription":" ",
"studentNotes":"Advisor Student Notes",
"contactNotes":"Advisor Course Notes",
"isImportant":true,
"isTranscript":false,
"electiveId":"3bdda584-f7a2-4402-8863-4b5bd8273009",
"creditHours":2.00,
"isDev":true,
"orderInTerm":1,
"planToOffer":null,
"personId":"64a97729-7999-4b31-b70b-f0b705dff288",
"duplicateOfTranscript":false,
"dev":true,
"isValidInTerm":true,
"hasPrerequisites":true,
"hasCorequisites":true,
"invalidReasons":""}]
}