| Info |
|---|
This API will not be available until SSP v2.0 |
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",
"message":"",
"results":19,
"rows":[
{
"id":"58ba5ee3c0a80097-734e5637-4ae911d3-b9c58156-943774b4de413776d34a0004",
"createdDate":"1331269200000",1469809349450,
"createdBy":{
"id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
"firstName":"JohnAmy",
"lastName":"Doe"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":"1331269200000"1469809349450,
"modifiedBy":{
"id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
"firstName":"JohnAmy",
"lastName":"DoeAdministrator",
}, "fullName":"Amy Administrator"
"objectStatus":"ACTIVE"},
"personIdobjectStatus":"b3c888f8-5056-a51a-8061-00a5435f98d9INACTIVE",
"contactTitlename":"Ms.Testing SSP3155 on 7/29",
"contactNameownerId":"Joan Jamesc0a80097-5210-159c-8152-10179f730006",
"contactPhoneownerName":"(212) 555-1234Amy Administrator",
"contactEmailownerEmail":"johnamy.james@hkjhfeadministrator@university.comedu",
"contactNotescontactTitle":"CallAcademic before NoonAdvisor",
"isAcceptedcontactName":true"Amy Administrator",
"planNamecontactPhone":"John Doe's Path To Success",
"dateAcceptedcontactEmail":"1331269200000amy.administrator@university.edu",
"totalTermCreditHourscontactNotes":105"",
"isOnPlancatalogYearCode":false"",
"studentNotes":""Summer,
classes may help complete the program quicker"isFinancialAid":false,
"isPledgeisImportant":false,
"academicGoalisF1Visa":"Graduate from a 4 year universityfalse,
"academicGoals":"",
"offPlanReasonacademicLink":"John",
had to pick up extra hours at work. "careerLink":"",
"isFinancialAidisValid":true,
"isImportanttermNotes":true,[
"isF1Visa":false],
"careerprogramCode":"http://www.careers.com/dental_hygenistCST-AS",
"academicpersonId":"http://www.academics.com/dental_hygenist_classes"17b082d1-5a84-4fe3-88ad-c54e225821c7",
}"courses":null
] } |
Get Plan (MAP) Summary- Active Plan
Description
...
, |
...
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":"58ba5ee3c0a80097-734e5668-4ae91662-b9c58156-943774b4de416aea950f001b", "createdDate":"1331269200000"1470672573710, "createdBy":{ "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006", "firstName":"JohnAmy", "lastName":"Doe"Administrator", "fullName":"Amy Administrator" }, "modifiedDate":"1331269200000"1470672573710, "modifiedBy":{ "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006", "firstName":"JohnAmy", "lastName":"DoeAdministrator", }, "fullName":"Amy Administrator" "objectStatus":"ACTIVE"}, "personIdobjectStatus":"b3c888f8-5056-a51a-8061-00a5435f98d9INACTIVE", "contactTitlename":"Ms.Just for Paul", "contactNameownerId":"Joan Jamesc0a80097-5210-159c-8152-10179f730006", "contactPhoneownerName":"(212) 555-1234Amy Administrator", "contactEmailownerEmail":"johnamy.james@hkjhfeadministrator@university.comedu", "contactNotescontactTitle":"CallAcademic before NoonAdvisor", "isAcceptedcontactName":true"Amy Administrator", "planNamecontactPhone":"John Doe's Path To Success", "dateAcceptedcontactEmail":"1331269200000amy.administrator@university.edu", "totalTermCreditHourscontactNotes":105"", "isOnPlancatalogYearCode":false"", "studentNotes":""Summer, classes may help complete the program quicker"isFinancialAid":false, "isPledgeisImportant":false, "academicGoalisF1Visa":"Graduate from a 4 year university"false, "offPlanReasonacademicGoals":""John, had to pick up extra hours at work. "academicLink":"", "isFinancialAidcareerLink":true"", "isImportantisValid":true, "isF1VisatermNotes":false[ ], "careerprogramCode":"http://www.careers.com/dental_hygenistCST-AS", "academicpersonId":"http://www.academics.com/dental_hygenist_classes"17b082d1-5a84-4fe3-88ad-c54e225821c7", } "courses":null ] } |
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":"58ba5ee392882a2b-734e1e06-4ae948ee-b9c5b517-943774b4de41927c274fadcc", "createdDate":"1331269200000"1400647359900, "createdBy":{ "id":"91f46e39b86149c8-cea8d916-422b4274-b215b2d5-00f6bcf5d280b85e15848062", "firstName":"JohnDemo", "lastName":"DoeCoach13", "fullName":"Demo Coach13" }, "modifiedDate":"1331269200000"1400647359900, "modifiedBy":{ "id":"91f46e39b86149c8-cea8d916-422b4274-b215b2d5-00f6bcf5d280b85e15848062", "firstName":"JohnDemo", "lastName":"DoeCoach13", }, "objectStatus"fullName":"ACTIVEDemo Coach13", "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9"}, "contactTitleobjectStatus":"Ms.INACTIVE", "contactNamename":"JoanAssociate James",in Automotive Technology - Part Time", "contactPhoneownerId":"(212) 555-1234b86149c8-d916-4274-b2d5-b85e15848062", "contactEmailownerName":"john.james@hkjhfe.comDemo Coach13", "contactNotesownerEmail":"Call before Noondemocoach@trainingssp.com", "isAcceptedcontactTitle":true"Coach", "planNamecontactName":"John Doe's Path To SuccessCoach", "dateAcceptedcontactPhone":"1331269200000555-555-1234", "totalTermCreditHourscontactEmail":105"sample@sample.com", "isOnPlancontactNotes":false"This is important.", "studentNotescatalogYearCode":"Summer classes may help complete the program quicker21-22", "isPledgestudentNotes":false, "academicGoal":"Graduate from a 4 year university", "offPlanReasonisFinancialAid":"John had to pick up extra hours at work."false, "isFinancialAidisImportant":true, "isImportantisF1Visa":truefalse, "isF1VisaacademicGoals":false"Graduate", "careeracademicLink":"http://www.careersunicon.com/dental_hygenistnet/opensource/student-success-plan", "academiccareerLink":"http://www.academicsunicon.com/dental_hygenist_classesnet/opensource/student-success-plan", "planCoursesisValid":[true, "termNotes":[ { ], "idprogramCode":"ce0d041d-d3ac-42a1-9085-7f744240e07e", AUMT-AS", "createdDatepersonId":"133126920000017b082d1-5a84-4fe3-88ad-c54e225821c7", "courses":null "createdBy":{}, { "id":"91f46e39c0a80097-cea856b7-422b1bf4-b2158156-00f6bcf5d280b7578cfd0000", "createdDate":1471954783487, "firstNamecreatedBy":"John",{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"DoeAdministrator", "fullName":"Amy Administrator" }, }, "modifiedDate":"1331269200000", 1471954783487, "modifiedBy":{ "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006", "firstName":"JohnAmy", "lastName""lastName":"DoeAdministrator", "fullName":"Amy Administrator" }, }, "objectStatus":"ACTIVEINACTIVE", "name":"Testing Electives", "personIdownerId":"b3c888f8c0a80097-50565210-a51a159c-80618152-00a5435f98d910179f730006", "courseId"ownerName":"BIO128Amy Administrator", "ownerEmail":"amy.administrator@university.edu", "order":1, "contactTitle":"Academic Advisor", "courseLabelcontactName":"BIOAmy 128Administrator", "contactPhone":"", "maxCreditHourscontactEmail":5"amy.administrator@university.edu", "contactNotes":"", "totalCreditHourscatalogYearCode":5,"", "studentNotes":"", "changedCreditHoursisFinancialAid":0false, "isImportant":false, "isTranscriptisF1Visa":true, false, "notesacademicGoals":"This class", can be difficult if you haven't taken BIO in HS"academicLink":"", "notesForAdvisor":"Advise student to brush up on HS BIO"careerLink":"", "isCritical"isValid":true, "termNotes":[ "isPElective":false, ], "courseTypeIdprogramCode":"b3c888f8-5056-a51a-8061-00a5435f98d9CST-AS", "termCodepersonId":"FA-13"17b082d1-5a84-4fe3-88ad-c54e225821c7", "courses":null } ]}, { "termNotes":[ { ""id":"ce0d041dc0a80097-d3ac56bb-42a11da7-90858156-7f744240e07ebcc93263001b", "createdDate":"1331269200000", 1472046117477, "createdBy":{ "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006", "firstName":"JohnAmy", "lastName":"DoeAdministrator", "fullName":"Amy Administrator" }, }, "modifiedDate":"1331269200000"1472046117477, ""modifiedBy":{ "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006", "firstName":"JohnAmy", "lastName":"Administrator", "lastNamefullName":"DoeAmy Administrator" }, }, "objectStatus":"INACTIVE", "isCriticalname":false,"Testing Template Saved as a Plan", "termCodeownerId":"FA-13c0a80097-5210-159c-8152-10179f730006", "ownerName":"Amy Administrator", "notesownerEmail":"John is also working full time this semester",amy.administrator@university.edu", "contactTitle":"Academic Advisor", "contactName":"Amy Administrator", "termNotesForAdvisorscontactPhone":""John, is at risk because of outside commitments" "contactEmail":"amy.administrator@university.edu", "contactNotes":"", } "catalogYearCode":"", ] }"studentNotes":"", ] } |
Get Full Plan (MAP)- Active Plan
Description
Paginated collection, but containing only the current active plan for {person-uuid}
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/full?status=ACTIVE
Security
PERSON_MAP_READ
Returns
| Code Block |
|---|
{ "successisFinancialAid":"true"false, "results":1, "rowsisImportant":[ false, { "isF1Visa":false, "idacademicGoals":"58ba5ee3-734e-4ae9-b9c5-943774b4de41", "createdDateacademicLink":"1331269200000", "createdBycareerLink":{ "", "idisValid":"91f46e39-cea8-422b-b215-00f6bcf5d280", true, "firstNametermNotes":"John",[ "lastName":"Doe"], }"programCode":"CST-AS", "modifiedDatepersonId":"133126920000017b082d1-5a84-4fe3-88ad-c54e225821c7", "modifiedBycourses":{null }, "id":"91f46e39-cea8-422b-b215-00f6bcf5d280{ "id":"c0a80097-56da-132c-8156-db0381b6001b", "firstNamecreatedDate":"John"1472553255350, "lastNamecreatedBy":"Doe" { }, "objectStatusid":"ACTIVEc0a80097-5210-159c-8152-10179f730006", "personIdfirstName":"b3c888f8-5056-a51a-8061-00a5435f98d9Amy", "contactTitlelastName":"Ms.Administrator", "contactNamefullName":"JoanAmy JamesAdministrator", "contactPhone":"(212) 555-1234",}, "contactEmailmodifiedDate":"john.james@hkjhfe.com"1481743969877, "contactNotesmodifiedBy":"Call before Noon",{ "isAcceptedid":true,"c0a80097-5210-159c-8152-10179f730006", "planNamefirstName":"John Doe's Path To Success", Amy", "dateAcceptedlastName":"1331269200000Administrator", "totalTermCreditHoursfullName":105,"Amy Administrator" "isOnPlan":false}, "studentNotesobjectStatus":"ACTIVE"Summer, classes may help complete the program quicker "name":"Testing Non-Course Requisite", "isPledgeownerId":false"c0a80097-5210-159c-8152-10179f730006", "academicGoalownerName":"Graduate from a 4 year universityAmy Administrator", "offPlanReasonownerEmail":"John had to pick up extra hours at work."amy.administrator@university.edu", "contactTitle":"Academic Advisor", "isFinancialAidcontactName":true"Amy Administrator", "isImportantcontactPhone":true"", "isF1VisacontactEmail":false"amy.administrator@university.edu", "careercontactNotes":"http://www.careers.com/dental_hygenist", "academiccatalogYearCode":"http://www.academics.com/dental_hygenist_classes", "planCoursesstudentNotes":["", "isFinancialAid":false, { "isImportant":false, "idisF1Visa":"ce0d041d-d3ac-42a1-9085-7f744240e07e"false, "academicGoals":"", "createdDateacademicLink":"1331269200000", "createdBycareerLink":{"", "isValid":true, "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",termNotes":[ ], "firstNameprogramCode":"John", "lastName"personId":"Doe"17b082d1-5a84-4fe3-88ad-c54e225821c7", "courses":null }, { "modifiedDateid":"1331269200000c0a80097-55fe-1ee1-8155-ff450b320005", "createdDate":1468866562867, "modifiedBycreatedBy":{ "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006", "firstName":"Amy", "firstName "lastName":"JohnAdministrator", "lastNamefullName":"DoeAmy Administrator" }, }, "modifiedDate":1468866658217, "objectStatusmodifiedBy":"ACTIVE", { "personIdid":"b3c888f8c0a80097-50565210-a51a159c-80618152-00a5435f98d910179f730006", "courseIdfirstName":"BIO128Amy", "orderlastName":1, "Administrator", "courseLabelfullName":"BIOAmy 128Administrator", }, "maxCreditHours":5, "objectStatus":"INACTIVE", "totalCreditHoursname":5"SSP-3174", "ownerId":"c0a80097-5210-159c-8152-10179f730006", "changedCreditHoursownerName":0"Amy Administrator", "ownerEmail":"amy.administrator@university.edu", "isTranscript":true, "contactTitle":"Academic Advisor", "notescontactName":"ThisAmy classAdministrator", can be difficult if you haven't taken BIO in HS"contactPhone":"", "contactEmail":"amy.administrator@university.edu", "notesForAdvisorcontactNotes":"Advise", student to brush up on HS BIO", "catalogYearCode":"", "isCriticalstudentNotes":true"", "isFinancialAid":false, "isPElectiveisImportant":false, "isF1Visa":false, "courseTypeIdacademicGoals":"b3c888f8-5056-a51a-8061-00a5435f98d9", "termCodeacademicLink":"FA-13", "careerLink":"", } ]"isValid":true, "termNotes":[ {], "id"programCode":"ce0d041d-d3ac-42a1-9085-7f744240e07e", "createdDatepersonId":"133126920000017b082d1-5a84-4fe3-88ad-c54e225821c7", "courses":null "createdBy":{}, { "id":"91f46e39c0a80097-cea855fe-422b1ee1-b2158155-00f6bcf5d280ff4cfa4a004e", "createdDate":1468867082827, "firstNamecreatedBy":"John", { "lastNameid":"Doe" c0a80097-5210-159c-8152-10179f730006", }, "firstName":"Amy", "modifiedDatelastName":"1331269200000Administrator", "modifiedByfullName":{"Amy Administrator" }, "idmodifiedDate":"91f46e39-cea8-422b-b215-00f6bcf5d280"1468867082827, "modifiedBy":{ "firstName "id":"Johnc0a80097-5210-159c-8152-10179f730006", "lastName"firstName":"DoeAmy", }"lastName":"Administrator", "isCritical":false,"fullName":"Amy Administrator" }, "termCodeobjectStatus":"FA-13INACTIVE", "notes"name":"JohnAssociate isin alsoLaw workingEnforcement", full time this semester", "ownerId":"c0a80097-5210-159c-8152-10179f730006", "termNotesForAdvisorsownerName":"John is at risk because of outside commitments"Amy Administrator", "ownerEmail":"amy.administrator@university.edu", } ] "contactTitle":"", "contactName":"John Doe.", "contactPhone":"", "contactEmail":"", "contactNotes":"", "catalogYearCode":"", } ] } |
...
"studentNotes":"",
"isFinancialAid":false,
"isImportant":false,
"isF1Visa":false,
"academicGoals":"",
"academicLink":"",
"careerLink":"",
"isValid":true,
"termNotes":[
],
"programCode":"",
"personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
"courses":null
},
{
"id":"c0a80097-55fe-1ee1-8155-ffa96dbc00dd",
"createdDate":1468873141693,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1468873141693,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"INACTIVE",
"name":"SSP-3155",
"ownerId":"c0a80097-5210-159c-8152-10179f730006",
"ownerName":"Amy Administrator",
"ownerEmail":"amy.administrator@university.edu",
"contactTitle":"Academic Advisor",
"contactName":"Amy Administrator",
"contactPhone":"",
"contactEmail":"amy.administrator@university.edu",
"contactNotes":"",
"catalogYearCode":"",
"studentNotes":"",
"isFinancialAid":false,
"isImportant":false,
"isF1Visa":false,
"academicGoals":"",
"academicLink":"",
"careerLink":"",
"isValid":true,
"termNotes":[
],
"programCode":"CST-AS",
"personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
"courses":null
}
]
} |
Get All Plans (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
{plan id}: a specific MAP uuid
Returns
| Code Block |
|---|
id":"c0a80097-56da-132c-8156-db0381b6001b",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1481743969877,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Testing Non-Course Requisite",
"ownerId":"c0a80097-5210-159c-8152-10179f730006",
"ownerName":"Amy Administrator",
"ownerEmail":"amy.administrator@university.edu",
"contactTitle":"Academic Advisor",
"contactName":"Amy Administrator",
"contactPhone":"",
"contactEmail":"amy.administrator@university.edu",
"contactNotes":"",
"catalogYearCode":"",
"studentNotes":"",
"isFinancialAid":false,
"isImportant":false,
"isF1Visa":false,
"academicGoals":"",
"academicLink":"",
"careerLink":"",
"isValid":false,
"termNotes":[
],
"programCode":"",
"personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
"basedOnTemplateId":null,
"planCourses":[
{
"id":"c0a80097-58fe-1d97-8158-fed2ae450002",
"createdDate":1481743969860,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1481743969860,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"termCode":"FA2017",
"courseCode":"AES-118",
"formattedCourse":"AES118",
"courseTitle":"General Aerospace",
"courseDescription":"General Aerospace",
"studentNotes":"",
"contactNotes":"",
"isImportant":false,
"isTranscript":false,
"electiveId":null,
"electiveName":null,
"electiveCode":null,
"creditHours":3.00,
"isDev":false,
"orderInTerm":0,
"planToOffer":null,
"isValidInTerm":false,
"duplicateOfTranscript":false,
"hasPrerequisites":false,
"hasCorequisites":false,
"invalidReasons":"Course: AES118 is not currently offered in the selected term. Pre/co requisite + AES099 is missing.",
"personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
"originalFormattedCourse":null,
"planElectiveCourseElectives":null,
"dev":false
}
],
"planElectiveCourses":[
{
"id":"c0a80097-56da-132c-8156-db0381b6001d",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1472553255350,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"courseCode":"HST-201",
"formattedCourse":"HST201",
"courseTitle":"U.S. History I",
"courseDescription":" Course: HST201 is not currently offered in the selected term.",
"creditHours":3.00,
"planElectiveCourseElectives":[
{
"id":"c0a80097-56da-132c-8156-db0381b6001e",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1472553255350,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"courseCode":"HST-163",
"formattedCourse":"HST163",
"courseTitle":"Fundamentals of History",
"courseDescription":"Fundamentals of History",
"creditHours":4.00,
"planElectiveCourseId":"c0a80097-56da-132c-8156-db0381b6001d"
},
{
"id":"c0a80097-56da-132c-8156-db0381b6001f",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1472553255350,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"courseCode":"HST-198",
"formattedCourse":"HST198",
"courseTitle":"Enterprise History",
"courseDescription":"Enterprise History",
"creditHours":4.00,
"planElectiveCourseId":"c0a80097-56da-132c-8156-db0381b6001d"
}
.... |
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
| Code Block |
|---|
id":"c0a80097-56da-132c-8156-db0381b6001b",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1481743969877,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Testing Non-Course Requisite",
"ownerId":"c0a80097-5210-159c-8152-10179f730006",
"ownerName":"Amy Administrator",
"ownerEmail":"amy.administrator@university.edu",
"contactTitle":"Academic Advisor",
"contactName":"Amy Administrator",
"contactPhone":"",
"contactEmail":"amy.administrator@university.edu",
"contactNotes":"",
"catalogYearCode":"",
"studentNotes":"",
"isFinancialAid":false,
"isImportant":false,
"isF1Visa":false,
"academicGoals":"",
"academicLink":"",
"careerLink":"",
"isValid":false,
"termNotes":[
],
"programCode":"",
"personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
"basedOnTemplateId":null,
"planCourses":[
{
"id":"c0a80097-58fe-1d97-8158-fed2ae450002",
"createdDate":1481743969860,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1481743969860,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"termCode":"FA2017",
"courseCode":"AES-118",
"formattedCourse":"AES118",
"courseTitle":"General Aerospace",
"courseDescription":"General Aerospace",
"studentNotes":"",
"contactNotes":"",
"isImportant":false,
"isTranscript":false,
"electiveId":null,
"electiveName":null,
"electiveCode":null,
"creditHours":3.00,
"isDev":false,
"orderInTerm":0,
"planToOffer":null,
"isValidInTerm":false,
"duplicateOfTranscript":false,
"hasPrerequisites":false,
"hasCorequisites":false,
"invalidReasons":"Course: AES118 is not currently offered in the selected term. Pre/co requisite + AES099 is missing.",
"personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
"originalFormattedCourse":null,
"planElectiveCourseElectives":null,
"dev":false
}
],
"planElectiveCourses":[
{
"id":"c0a80097-56da-132c-8156-db0381b6001d",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1472553255350,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"courseCode":"HST-201",
"formattedCourse":"HST201",
"courseTitle":"U.S. History I",
"courseDescription":" Course: HST201 is not currently offered in the selected term.",
"creditHours":3.00,
"planElectiveCourseElectives":[
{
"id":"c0a80097-56da-132c-8156-db0381b6001e",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1472553255350,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"courseCode":"HST-163",
"formattedCourse":"HST163",
"courseTitle":"Fundamentals of History",
"courseDescription":"Fundamentals of History",
"creditHours":4.00,
"planElectiveCourseId":"c0a80097-56da-132c-8156-db0381b6001d"
},
{
"id":"c0a80097-56da-132c-8156-db0381b6001f",
"createdDate":1472553255350,
"createdBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":1472553255350,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"courseCode":"HST-198",
"formattedCourse":"HST198",
"courseTitle":"Enterprise History",
"courseDescription":"Enterprise History",
"creditHours":4.00,
"planElectiveCourseId":"c0a80097-56da-132c-8156-db0381b6001d"
}
]
}
]
} |
Print or Email (MAP)
Description
Prints or emails the active plan details for {person-uuid}
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/print
GET /ssp/api/1/person/{person-uuid}/map/plan/email
Security
PERSON_MAP_READ
Returns
Print: HTML report based on the message_template for "Map Plan Full Printout"
Email: email with HTML attachment