...
Get Plan (MAP) Summary
Description
Collection Paginated collection of all plan summaries for {person-uuid}, regardless of object_statusoptionally 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
| Code Block |
|---|
{
"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",
"contactTitle":"Ms.",
"contactName":"Joan James",
"contactPhone":"(212) 555-1234",
"contactEmail":"john.james@hkjhfe.com",
"contactNotes":"Call before Noon",
"isAccepted":true,
"planName":"John Doe's Path To Success",
"dateAccepted":"1331269200000",
"totalTermCreditHours":105,
"isOnPlan":false,
"studentNotes":"Summer classes may help complete the program quicker",
"isPledge":false,
"academicGoal":"Graduate from a 4 year university",
"offPlanReason":"John had to pick up extra hours at work.",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":false,
"career":"http://www.careers.com/dental_hygenist",
"academic":"http://www.academics.com/dental_hygenist_classes"
}
]
} |
Get Full Plan (MAP)
...
Description
Paginated collection
...
of all plan details for {person-uuid}
...
Method
GET /ssp/api/1/person/{person-uuid/map/plan/summary?status=ACTIVE
Security
PERSON_MAP_READ
Returns
| Code Block |
|---|
{
"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",
"contactTitle":"Ms.",
"contactName":"Joan James",
"contactPhone":"(212) 555-1234",
"contactEmail":"john.james@hkjhfe.com",
"contactNotes":"Call before Noon",
"isAccepted":true,
"planName":"John Doe's Path To Success",
"dateAccepted":"1331269200000",
"totalTermCreditHours":105,
"isOnPlan":false,
"studentNotes":"Summer classes may help complete the program quicker",
"isPledge":false,
"academicGoal":"Graduate from a 4 year university",
"offPlanReason":"John had to pick up extra hours at work.",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":false,
"career":"http://www.careers.com/dental_hygenist",
"academic":"http://www.academics.com/dental_hygenist_classes"
}
]
} |
Get Full Plan (MAP)
Description
Paginated collection of all plan details for {person-uuid}, regardless of object_status
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/full
Security
PERSON_MAP_READ
Returns
| Code Block |
|---|
{
"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",
"contactTitle":"Ms.",
"contactName":"Joan James",
"contactPhone":"(212) 555-1234",
"contactEmail":"john.james@hkjhfe.com",
"contactNotes":"Call before Noon",
"isAccepted":true,
"planName":"John Doe's Path To Success",
"dateAccepted":"1331269200000",
"totalTermCreditHours":105,
"isOnPlan":false,
"studentNotes":"Summer classes may help complete the program quicker",
"isPledge":false,
"academicGoal":"Graduate from a 4 year university",
"offPlanReason":"John had to pick up extra hours at work.",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":false,
"career":"http://www.careers.com/dental_hygenist",
"academic":"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",
"courseId":"BIO128",
"order":1,
"courseLabel":"BIO 128",
"maxCreditHours":5,
"totalCreditHours":5,
"changedCreditHours":0,
"isTranscript":true,
"notes":"This class can be difficult if you haven't taken BIO in HS",
"notesForAdvisor":"Advise student to brush up on HS BIO",
"isCritical":true,
"isPElective":false,
"courseTypeId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
"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"
},
"isCritical":false,
"termCode":"FA-13",
"notes":"John is also working full time this semester",
"termNotesForAdvisors":"John is at risk because of outside commitments"
}
]
}
]
} |
Get Full Plan (MAP)- Active Plan
Description
Paginated collection, but containing only the current active plan 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/full?status=ACTIVE
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
| Code Block |
|---|
{
"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",
"contactTitle":"Ms.",
"contactName":"Joan James",
"contactPhone":"(212) 555-1234",
"contactEmail":"john.james@hkjhfe.com",
"contactNotes":"Call before Noon",
"isAccepted":true,
"planName":"John Doe's Path To Success",
"dateAccepted":"1331269200000",
"totalTermCreditHours":105,
"isOnPlan":false,
"studentNotes":"Summer classes may help complete the program quicker",
"isPledge":false,
"academicGoal":"Graduate from a 4 year university",
"offPlanReason":"John had to pick up extra hours at work.",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":false,
"career":"http://www.careers.com/dental_hygenist",
"academic":"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",
"courseId":"BIO128",
"order":1,
"courseLabel":"BIO 128",
"maxCreditHours":5,
"totalCreditHours":5,
"changedCreditHours":0,
"isTranscript":true,
"notes":"This class can be difficult if you haven't taken BIO in HS",
"notesForAdvisor":"Advise student to brush up on HS BIO",
"isCritical":true,
"isPElective":false,
"courseTypeId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
"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"
},
"isCritical":false,
"termCode":"FA-13",
"notes":"John is also working full time this semester",
"termNotesForAdvisors":"John is at risk because of outside commitments"
}
]
}
]
} |