Versions Compared

Old Version 13

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",
            "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"studentNotes":"",
         "academicGoalsisFinancialAid":"Graduate from a 4 year university"false,
         "isImportant":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,
         "planToOffer":null,
         "isValidInTerm":false,
         "duplicateOfTranscript":false,
         "hasPrerequisites":false,
          "idhasCorequisites":"58ba5ee3-734e-4ae9-b9c5-943774b4de41"false,
         "invalidReasons"createdDate:"Course:1331269200000, AES118 is not currently offered in the selected  "createdBy":{
  term. Pre/co requisite + AES099 is missing.",
         "idpersonId":"91f46e3917b082d1-cea85a84-422b4fe3-b21588ad-00f6bcf5d280c54e225821c7",
  
         "firstNameoriginalFormattedCourse":"John"null,
         "planElectiveCourseElectives":null,
  "lastName":"Doe"       "dev":false
    },  }
   ],
   "modifiedDateplanElectiveCourses":1331269200000,[  
       "modifiedBy":{
  
         "id":"91f46e39c0a80097-cea856da-422b132c-b2158156-00f6bcf5d280db0381b6001d",
  
         "firstNamecreatedDate":"John"1472553255350,
            "lastNamecreatedBy":"Doe"
         },
    {  
  "objectStatus":"ACTIVE",          "personIdid":"b3c888f8c0a80097-50565210-a51a159c-80618152-00a5435f98d910179f730006",
            "ownerIdfirstName": "da572870-5699-11e2-be1e-406c8f22c3ce"Amy",
            "contactTitlelastName":"Ms.Administrator",
            "contactNamefullName":"JoanAmy JamesAdministrator",
         "contactPhone":"(212) 555-1234"},
         "contactEmailmodifiedDate":"john.james@hkjhfe.com"1472553255350,
         "contactNotesmodifiedBy":"Call before Noon",{  
            "nameid":"John Doe's Path To Success",
c0a80097-5210-159c-8152-10179f730006",
            "isOnPlanfirstName":false,"Amy",
            "studentNoteslastName":"Summer classes may help complete the program quicker","Administrator",
            "academicGoalsfullName":"GraduateAmy fromAdministrator"
a 4 year university",      },
   "offPlanReason":"John had to pick up extra hours at work. "objectStatus":"ACTIVE",
         "isFinancialAidcourseCode":true"HST-201",
         "isImportantformattedCourse":true"HST201",
         "isF1VisacourseTitle":false"U.S. History I",
         "careerLinkcourseDescription":"http://www.careers.com/dental_hygenist Course: HST201 is not currently offered in the selected 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":"Doe"
         Administrator",
     },                "modifiedDatefullName":1331269200000,
               "modifiedBy":{"Amy Administrator"
                  "id":"91f46e39-cea8-422b-b215-00f6bcf5d280",
  },
               "firstNamemodifiedDate":"John"1472553255350,
               "modifiedBy":{  
 "lastName":"Doe"                 },"id":"c0a80097-5210-159c-8152-10179f730006",
                  "objectStatusfirstName":"ACTIVEAmy",
                  "personIdlastName":"b3c888f8-5056-a51a-8061-00a5435f98d9Administrator",
                  "courseCodefullName":"BIO128_12345Amy Administrator"
               "formattedCourse":"BIO128"},
               "courseTitleobjectStatus":"Cell BiologyACTIVE",
      
        "courseTitle":"Cell Biology Description",  			   "orderInTermcourseCode":1"HST-163",
               "creditHoursformattedCourse":5"HST163",
               "isTranscriptcourseTitle":true"Fundamentals of History",
               "studentNotescourseDescription":"This class can be difficult if you haven't taken BIO in HS""Fundamentals of History",
               "creditHours":4.00,
               "contactNotesplanElectiveCourseId":"Advise student to brush up on HS BIO""c0a80097-56da-132c-8156-db0381b6001d"
            },
            {  
"isImportant":true,                "isDevid":true"c0a80097-56da-132c-8156-db0381b6001f",
               "electiveIdscreatedDate":[ {"id":"1d93a1b5-a2d9-11e2-8d55-406c8f22c3ce"},1472553255350,
               "createdBy":{  
                  {"id":"2b69aff5c0a80097-a2d95210-11e2159c-a8818152-406c8f22c3ce10179f730006"),
  ],                "termCodefirstName":"FA-13"
  Amy",
         }          ]"lastName":"Administrator",
         "termNotes":[         "fullName":"Amy Administrator"
  {                "id":"ce0d041d-d3ac-42a1-9085-7f744240e07e"},
               "createdDatemodifiedDate":13312692000001472553255350,
               "createdBymodifiedBy":{  
                  "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
                  "firstName":"JohnAmy",
                  "lastName":"DoeAdministrator",
               },                "modifiedDate":1331269200000,
 "fullName":"Amy Administrator"
             "modifiedBy":{  },
                "idobjectStatus":"91f46e39-cea8-422b-b215-00f6bcf5d280ACTIVE",
                  "firstNamecourseCode":"JohnHST-198",
                  "lastNameformattedCourse":"DoeHST198",
               }"courseTitle":"Enterprise History",
               "objectStatuscourseDescription":"ACTIVEEnterprise History",
               "isImportantcreditHours":false4.00,
               "termCodeplanElectiveCourseId":"FA-13",c0a80097-56da-132c-8156-db0381b6001d"
            }
         ]
  "studentNotes":"John is also working full time this semester",
               "contactNotes":"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