...
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.
...
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":13312692000001469809349450,
"createdBy":{
"id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
"firstName":"JohnAmy",
"lastName":"Doe"Administrator",
"fullName":"Amy Administrator"
},
"modifiedDate":13312692000001469809349450,
"modifiedBy":{
"id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
"firstName":"JohnAmy",
"lastName":"Doe"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVEINACTIVE",
"personIdname":"b3c888f8-5056-a51a-8061-00a5435f98d9Testing SSP3155 on 7/29",
"ownerId": "da572870c0a80097-56995210-11e2159c-be1e8152-406c8f22c3ce10179f730006",
"contactTitleownerName":"Ms.Amy Administrator",
"contactNameownerEmail":"Joan Jamesamy.administrator@university.edu",
"contactPhonecontactTitle":"(212) 555-1234Academic Advisor",
"contactEmailcontactName":"john.james@hkjhfe.comAmy Administrator",
"contactNotescontactPhone":"Call before Noon",
"namecontactEmail":"John Doe's Path To Successamy.administrator@university.edu",
"isOnPlancontactNotes":false"",
"studentNotescatalogYearCode":"Summer classes may help complete the program quicker",
"academicGoalsstudentNotes":"Graduate from a 4 year university",
"offPlanReasonisFinancialAid":"John had to pick up extra hours at work."false,
"isImportant":false,
"isFinancialAidisF1Visa":truefalse,
"isImportantacademicGoals":true"",
"isF1VisaacademicLink":false"",
"careerLink":"http://www.careers.com/dental_hygenist",
"academicLinkisValid":"http://www.academics.com/dental_hygenist_classes"true,
"termNotes":[
} ]
} |
Get All Plans (MAP)
Description
...
,
"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
| 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
...
Parameters
...
...
Returns
...
Returns
| Code Block |
|---|
id":"c0a80097-56da-132c-8156-db0381b6001b", "resultscreatedDate":11472553255350, "rowscreatedBy":[ { "id":"58ba5ee3c0a80097-734e5210-4ae9159c-b9c58152-943774b4de4110179f730006", "firstName":"Amy", "createdDatelastName":1331269200000"Administrator", "fullName":"Amy Administrator" "createdBy}, "modifiedDate":{1481743969877, "modifiedBy":{ "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006", "firstName":"JohnAmy", "lastName":"DoeAdministrator", "fullName":"Amy Administrator" }, "modifiedDateobjectStatus":1331269200000"ACTIVE", "name":"Testing Non-Course Requisite", "modifiedByownerId":{"c0a80097-5210-159c-8152-10179f730006", "ownerName":"Amy Administrator", "idownerEmail":"91f46e39-cea8-422b-b215-00f6bcf5d280amy.administrator@university.edu", "contactTitle":"Academic Advisor", "contactName":"Amy Administrator", "firstNamecontactPhone":"John", "contactEmail":"amy.administrator@university.edu", "contactNotes":"", "lastNamecatalogYearCode":"Doe", "studentNotes":"", }"isFinancialAid":false, "isImportant":false, "objectStatusisF1Visa":"ACTIVE", false, "personIdacademicGoals":"b3c888f8-5056-a51a-8061-00a5435f98d9", "academicLink":"", "ownerIdcareerLink": "da572870-5699-11e2-be1e-406c8f22c3ce", "isValid":false, "contactTitletermNotes":"Ms.",[ ], "contactNameprogramCode":"Joan James", "contactPhonepersonId":"(212) 555-123417b082d1-5a84-4fe3-88ad-c54e225821c7", "basedOnTemplateId":null, "contactEmailplanCourses":"john.james@hkjhfe.com",[ "contactNotes":"Call before Noon",{ "nameid":"John Doe's Path To Successc0a80097-58fe-1d97-8158-fed2ae450002", "isOnPlancreatedDate":false1481743969860, "studentNotescreatedBy":"Summer{ classes may help complete the program quicker", "academicGoalsid":"Graduate from a 4 year university","c0a80097-5210-159c-8152-10179f730006", "offPlanReasonfirstName":"John had to pick up extra hours at work.",Amy", "lastName":"Administrator", "isFinancialAidfullName":true,"Amy Administrator" "isImportant":true}, "isF1VisamodifiedDate":false1481743969860, "careerLink":"http://www.careers.com/dental_hygenist",modifiedBy":{ "academicLinkid":"http://www.academics.com/dental_hygenist_classes",c0a80097-5210-159c-8152-10179f730006", "planCoursesfirstName":["Amy", { "lastName":"Administrator", "idfullName":"ce0d041d-d3ac-42a1-9085-7f744240e07e",Amy Administrator" }, "createdDateobjectStatus":1331269200000"ACTIVE", "termCode":"FA2017", "createdBycourseCode":{"AES-118", "formattedCourse":"AES118", "idcourseTitle":"91f46e39-cea8-422b-b215-00f6bcf5d280General Aerospace", "courseDescription":"General Aerospace", "firstNamestudentNotes":"John", "contactNotes":"", "lastNameisImportant":"Doe"false, "isTranscript":false, }, "electiveId":null, "modifiedDateelectiveName":1331269200000null, "electiveCode":null, "modifiedBycreditHours":{3.00, "isDev":false, "idorderInTerm":"91f46e39-cea8-422b-b215-00f6bcf5d280"0, "planToOffer":null, "firstNameisValidInTerm":"John"false, "duplicateOfTranscript":false, "lastName":"Doe" "hasPrerequisites":false, "hasCorequisites":false, }, "invalidReasons":"Course: AES118 is not currently offered in the "objectStatus":"ACTIVE", selected term. Pre/co requisite + AES099 is missing.", "personId":"b3c888f817b082d1-50565a84-a51a4fe3-806188ad-00a5435f98d9c54e225821c7", "originalFormattedCourse":null, "courseCode":"BIO128_12345" "planElectiveCourseElectives":null, "formattedCoursedev":"BIO128",false } ], "courseTitleplanElectiveCourses":"Cell Biology",[ { "courseDescriptionid":"Cell Biology Descriptionc0a80097-56da-132c-8156-db0381b6001d", "orderInTerm":1, "createdDate":1472553255350, "creditHourscreatedBy":5, { "isTranscriptid":true, "c0a80097-5210-159c-8152-10179f730006", "studentNotesfirstName":"ThisAmy", class can be difficult if you haven't taken BIO in HS "lastName":"Administrator", "contactNotesfullName":"Advise student to brush up on HS BIO",Amy Administrator" }, "isImportantmodifiedDate":true, 1472553255350, "isDevmodifiedBy":true, { "electiveIds":[ {"id":"1d93a1b5c0a80097-a2d95210-11e2159c-8d558152-406c8f22c3ce10179f730006"}, "firstName":"Amy", {"id":"2b69aff5-a2d9-11e2-a881-406c8f22c3ce") ], "lastName":"Administrator", "termCodefullName":"FA-13" Amy Administrator" }, ]"objectStatus":"ACTIVE", "termNotescourseCode":["HST-201", "formattedCourse":"HST201", { "courseTitle":"U.S. History I", "idcourseDescription":"ce0d041d-d3ac-42a1-9085-7f744240e07e", Course: HST201 is not currently offered in the selected term.", "creditHours":3.00, "createdDateplanElectiveCourseElectives":1331269200000, [ "createdBy":{ "id":"91f46e39c0a80097-cea856da-422b132c-b2158156-00f6bcf5d280db0381b6001e", "firstNamecreatedDate":"John"1472553255350, "lastNamecreatedBy":"Doe" { }, "modifiedDateid":1331269200000, "modifiedBy":{"c0a80097-5210-159c-8152-10179f730006", "idfirstName":"91f46e39-cea8-422b-b215-00f6bcf5d280Amy", "firstNamelastName":"JohnAdministrator", "lastNamefullName":"DoeAmy Administrator" }, "objectStatusmodifiedDate":"ACTIVE"1472553255350, "isImportantmodifiedBy":false,{ "termCodeid":"FA-13c0a80097-5210-159c-8152-10179f730006", "studentNotesfirstName":"Amy"John, is also working full time this semester", "contactNoteslastName":"John is at risk because of outside commitments"Administrator", } ] "fullName":"Amy Administrator" } ] } |
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":"0a90940a-3fc7-1f00-813f-ca10fee70002" }, "createdDate":1373484678888, "createdBy":{ "idobjectStatus":"0a90940a-3efc-175f-813e-fc1ac581000bACTIVE", "firstName":"Amy", "lastNamecourseCode":"Administrator"HST-163", }, "modifiedDate":1373484778372, "modifiedByformattedCourse":{"HST163", "id":"0a90940a-3efc-175f-813e-fc1ac581000b", "firstNamecourseTitle":"AmyFundamentals of History", "lastName":"Administrator" }, "objectStatuscourseDescription":"ACTIVEFundamentals of History", "name":"Sample Plan", "ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b", "ownerNamecreditHours":"Amy Administrator",4.00, "contactTitle":"Advisor", "contactName":"John Smith", "contactPhoneplanElectiveCourseId":"212-555-1212",c0a80097-56da-132c-8156-db0381b6001d" "contactEmail":"advisor@college.edu", "contactNotes":"Advisor Plan Notes"}, "studentNotes":"Student Plan Notes", "isFinancialAid":true,{ "isImportant":true, "isF1Visa":true, "academicGoals":"Goals for Academics", "academicLinkid":"http://www.college.edu/academic.html",c0a80097-56da-132c-8156-db0381b6001f", "careerLinkcreatedDate":"http://www.college.edu/career.html",1472553255350, "isValid "createdBy":true,{ "termNotes":[ { "id":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b10179f730006", "firstName":"Amy", "lastName":"Administrator", }, "objectStatus":"ACTIVE", "studentNotes":"Student Term Notes", "contactNotesfullName":"Amy Administrator"Advisor Term Notes", "termCode":"FA2013", "isImportant":true}, "planCourses":[ }, { "idmodifiedDate":"0a90940a-3fc7-1f00-813f-ca1283680016",1472553255350, "createdDatemodifiedBy":1373484778344,{ "createdBy":{ "id":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b",10179f730006", "firstName":"Amy", "lastName":"Administrator"},, "modifiedDatefullName":1373484778344,"Amy Administrator" "modifiedBy":{ "id":"0a90940a-3efc-175f-813e-fc1ac581000b",}, "firstNameobjectStatus":"AmyACTIVE", "lastName":"Administrator"}, "objectStatuscourseCode":"ACTIVEHST-198", "termCode":"FA2013", "courseCodeformattedCourse":"IEE-105HST198", "formattedCourse":"IEE105", "courseTitle":"AnalyticalEnterprise Industrial EngineeringHistory", "courseDescription":" ", "studentNotescourseDescription":"AdvisorEnterprise Student NotesHistory", "contactNotes":"Advisor Course Notes", "isImportantcreditHours":true4.00, "isTranscript":false, "electiveIdplanElectiveCourseId":"3bdda584c0a80097-f7a256da-4402132c-88638156-4b5bd8273009db0381b6001d", "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":""}] } |
...
]
} |
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