Plan (MAP) API
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", "message":"", "results":9, "rows":[ { "id":"c0a80097-5637-11d3-8156-3776d34a0004", "createdDate":1469809349450, "createdBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "modifiedDate":1469809349450, "modifiedBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "objectStatus":"INACTIVE", "name":"Testing SSP3155 on 7/29", "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 }, { "id":"c0a80097-5668-1662-8156-6aea950f001b", "createdDate":1470672573710, "createdBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "modifiedDate":1470672573710, "modifiedBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "objectStatus":"INACTIVE", "name":"Just for Paul", "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 }, { "id":"92882a2b-1e06-48ee-b517-927c274fadcc", "createdDate":1400647359900, "createdBy":{ "id":"b86149c8-d916-4274-b2d5-b85e15848062", "firstName":"Demo", "lastName":"Coach13", "fullName":"Demo Coach13" }, "modifiedDate":1400647359900, "modifiedBy":{ "id":"b86149c8-d916-4274-b2d5-b85e15848062", "firstName":"Demo", "lastName":"Coach13", "fullName":"Demo Coach13" }, "objectStatus":"INACTIVE", "name":"Associate in Automotive Technology - Part Time", "ownerId":"b86149c8-d916-4274-b2d5-b85e15848062", "ownerName":"Demo Coach13", "ownerEmail":"democoach@trainingssp.com", "contactTitle":"Coach", "contactName":"Coach", "contactPhone":"555-555-1234", "contactEmail":"sample@sample.com", "contactNotes":"This is important.", "catalogYearCode":"21-22", "studentNotes":"", "isFinancialAid":false, "isImportant":true, "isF1Visa":false, "academicGoals":"Graduate", "academicLink":"http://www.unicon.net/opensource/student-success-plan", "careerLink":"http://www.unicon.net/opensource/student-success-plan", "isValid":true, "termNotes":[ ], "programCode":"AUMT-AS", "personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7", "courses":null }, { "id":"c0a80097-56b7-1bf4-8156-b7578cfd0000", "createdDate":1471954783487, "createdBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "modifiedDate":1471954783487, "modifiedBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "objectStatus":"INACTIVE", "name":"Testing Electives", "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 }, { "id":"c0a80097-56bb-1da7-8156-bcc93263001b", "createdDate":1472046117477, "createdBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "modifiedDate":1472046117477, "modifiedBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "objectStatus":"INACTIVE", "name":"Testing Template Saved as a Plan", "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 }, { "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":true, "termNotes":[ ], "programCode":"", "personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7", "courses":null }, { "id":"c0a80097-55fe-1ee1-8155-ff450b320005", "createdDate":1468866562867, "createdBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "modifiedDate":1468866658217, "modifiedBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "objectStatus":"INACTIVE", "name":"SSP-3174", "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":"", "personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7", "courses":null }, { "id":"c0a80097-55fe-1ee1-8155-ff4cfa4a004e", "createdDate":1468867082827, "createdBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "modifiedDate":1468867082827, "modifiedBy":{ "id":"c0a80097-5210-159c-8152-10179f730006", "firstName":"Amy", "lastName":"Administrator", "fullName":"Amy Administrator" }, "objectStatus":"INACTIVE", "name":"Associate in Law Enforcement", "ownerId":"c0a80097-5210-159c-8152-10179f730006", "ownerName":"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
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
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