Versions Compared

Old Version 11

changes.mady.by.user Daniel McCallum

Saved on

compared with

New Version Current

changes.mady.by.user Jason Elwood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

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.

...

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":"DoeAdministrator"
 ,
       },          "objectStatusfullName":"ACTIVEAmy Administrator",
         "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9"},
         "contactTitleobjectStatus":"Ms.INACTIVE",
         "contactNamename":"Joan JamesTesting SSP3155 on 7/29",
         "contactPhoneownerId":"(212) 555-1234c0a80097-5210-159c-8152-10179f730006",
         "contactEmailownerName":"john.james@hkjhfe.comAmy Administrator",
         "contactNotesownerEmail":"Call before Noonamy.administrator@university.edu",
         "isAcceptedcontactTitle":true"Academic Advisor",
         "planNamecontactName":"John Doe's Path To SuccessAmy Administrator",
         "dateAcceptedcontactPhone":1331269200000"",
         "totalTermCreditHourscontactEmail":105"amy.administrator@university.edu",
         "isOnPlancontactNotes":false"",
         "studentNotescatalogYearCode":""Summer,
   classes may help complete the program quicker"studentNotes":"",
         "isPledgeisFinancialAid":false,
         "academicGoalisImportant":"Graduate from a 4 year university"false,
         "offPlanReasonisF1Visa":"John had to pick up extra hours at work.false,
         "academicGoals":"",
         "isFinancialAidacademicLink":true"",
         "isImportantcareerLink":true"",
         "isF1VisaisValid":falsetrue,
         "careerLink":"http://www.careers.com/dental_hygenist"termNotes":[  

         ],
         "academicLinkprogramCode":"http://www.academics.com/dental_hygenist_classes"CST-AS",
      }    ]
}

Get Full 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/full

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":[
      {"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

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,
          "idplanToOffer":"58ba5ee3-734e-4ae9-b9c5-943774b4de41"null,
         "createdDateisValidInTerm":1331269200000false,
         "createdByduplicateOfTranscript":{
 false,
          "idhasPrerequisites":"91f46e39-cea8-422b-b215-00f6bcf5d280",
 false,
          "firstNamehasCorequisites":"John"false,
            "lastNameinvalidReasons":"Doe"
         }Course: AES118 is not currently offered in the selected term. Pre/co requisite + AES099 is missing.",
         "modifiedDatepersonId":1331269200000"17b082d1-5a84-4fe3-88ad-c54e225821c7",
         "modifiedByoriginalFormattedCourse":{null,
            "idplanElectiveCourseElectives":"91f46e39-cea8-422b-b215-00f6bcf5d280",
  null,
         "firstNamedev":"John",false
      }
   ],
   "lastNameplanElectiveCourses":"Doe"[  
      { },
         "objectStatus":"ACTIVE",
         "personIdid":"b3c888f8c0a80097-505656da-a51a132c-80618156-00a5435f98d9db0381b6001d",
         "contactTitlecreatedDate":"Ms."1472553255350,
         "contactNamecreatedBy":"Joan James",{  
            "contactPhoneid":"(212) 555-1234",c0a80097-5210-159c-8152-10179f730006",
            "contactEmailfirstName":"john.james@hkjhfe.comAmy",
            "contactNoteslastName":"Administrator"Call,
 before Noon",          "isAcceptedfullName":true,
   "Amy Administrator"
     "planName":"John Doe's Path To Success"},
         "dateAcceptedmodifiedDate":13312692000001472553255350,
         "totalTermCreditHoursmodifiedBy":105,{  
            "isOnPlanid":false,"c0a80097-5210-159c-8152-10179f730006",
            "studentNotesfirstName":"Summer classes may help complete the program quicker","Amy",
            "isPledgelastName":false"Administrator",
            "academicGoalfullName":"Graduate from a 4 year university"Amy Administrator"
         },
         "offPlanReasonobjectStatus":"JohnACTIVE",
  had to pick up extra hours at work. "courseCode":"HST-201",
         "isFinancialAidformattedCourse":true"HST201",
         "isImportantcourseTitle":true"U.S. History I",
         "isF1VisacourseDescription":false," Course: HST201 is not currently offered in the  "careerLink":"http://www.careers.com/dental_hygenistselected term.",
         "academicLinkcreditHours":"http://www.academics.com/dental_hygenist_classes"3.00,
         "planCoursesplanElectiveCourseElectives":[  
            {  
               "id":"ce0d041dc0a80097-d3ac56da-42a1132c-90858156-7f744240e07edb0381b6001e",
               "createdDate":13312692000001472553255350,
               "createdBy":{  
                  "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
                  "firstName":"JohnAmy",
                  "lastName":"Administrator",
                  "fullName":"DoeAmy Administrator"
               },
               "modifiedDate":13312692000001472553255350,
               "modifiedBy":{  
                  "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
                  "firstName":"JohnAmy",
                  "lastName":"Doe"
            Administrator",
  },                "objectStatusfullName":"ACTIVEAmy Administrator",
               "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9"},
               "formattedCourseobjectStatus":"BIO128ACTIVE",
               "ordercourseCode":1"HST-163",
               "maxCreditHoursformattedCourse":5"HST163",
               "totalCreditHourscourseTitle":5"Fundamentals of History",
               "changedCreditHourscourseDescription":0"Fundamentals of History",
               "isTranscriptcreditHours":true4.00,
               "notesplanElectiveCourseId":"This class can be difficult if you haven't taken BIO in HS",c0a80097-56da-132c-8156-db0381b6001d"
            },
         "notesForAdvisor":"Advise student to brush{ up on HS BIO",
               "isCriticalid":true"c0a80097-56da-132c-8156-db0381b6001f",
               "isPElectivecreatedDate":false1472553255350,
               "courseTypeId":"b3c888f8-5056-a51a-8061-00a5435f98d9",createdBy":{  
                  "termCodeid":"FA-13"c0a80097-5210-159c-8152-10179f730006",
                 }
 "firstName":"Amy",
        ],          "termNoteslastName":["Administrator",
                  {"fullName":"Amy Administrator"
               "id":"ce0d041d-d3ac-42a1-9085-7f744240e07e"},
               "createdDatemodifiedDate":13312692000001472553255350,
               "createdBymodifiedBy":{  
                  "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
                  "firstName":"JohnAmy",
                  "lastName":"DoeAdministrator",
               },
   "fullName":"Amy Administrator"
              "modifiedDate":1331269200000 },
               "modifiedByobjectStatus":{"ACTIVE",
                  "idcourseCode":"91f46e39-cea8-422b-b215-00f6bcf5d280HST-198",
                  "firstNameformattedCourse":"JohnHST198",
  
               "lastNamecourseTitle":"DoeEnterprise History",
                }"courseDescription":"Enterprise History",
               "isCriticalcreditHours":false4.00,
               "termCodeplanElectiveCourseId":"FA-13",c0a80097-56da-132c-8156-db0381b6001d"
            }
         ]
  "notes":"John is also working full time this semester",
               "termNotesForAdvisors":"John is at risk because of outside commitments"
            }
         ]
      }
   ]
}

 

 

...

    }
   ]
}

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