Versions Compared

Key

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

 

Get Plan (MAP) Summary

Description
Collection Paginated collection of all plan summaries for {person-uuid}, regardless of object_statusoptionally filtered by status. See API notes for status parameter handling handling.
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/summary

SecurityTBD

PERSON_MAP_READ

Parameters

status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return

Returns

Code Block
{  
   "success":"true",
   "message":"",
   "results":19,
   "rows":[  
      {  
         "id":"58ba5ee3c0a80097-734e5637-4ae911d3-b9c58156-943774b4de413776d34a0004",
         "createdDate":"1331269200000"1469809349450,
         "createdBy":{  
            "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
            "firstName":"JohnAmy",
            "lastName":"Doe"Administrator",
            "fullName":"Amy Administrator"
         },
         "modifiedDate":"1331269200000"1469809349450,
         "modifiedBy":{  
            "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
            "firstName":"JohnAmy",
            "lastName":"DoeAdministrator",
         },
         "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,
         "isF1Visa":false,
         "offPlanReasonacademicGoals":""John,
  had to pick up extra hours at work. "academicLink":"",
         "isFinancialAidcareerLink":true"",
         "isImportantisValid":true,
         "isF1VisatermNotes":false[  

         ],
         "careerprogramCode":"http://www.careers.com/dental_hygenistCST-AS",
         "academicpersonId":"http://www.academics.com/dental_hygenist_classes"
      }
   ]
}

Get Plan (MAP) Summary- Active Plan

Description
Paginated collection, but containing only the current active plan for {person-uuid}
Method
GET /ssp/api/1/person/{person-uuid/map/plan/summary?status=ACTIVE

Security

TBD

Returns

Code Block
{
   "success":"true",
   "results":1,
   "rows":[
      {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.",
         "idpersonId":"58ba5ee317b082d1-734e5a84-4ae94fe3-b9c588ad-943774b4de41c54e225821c7",
         "createdDateoriginalFormattedCourse":"1331269200000"null,
         "createdByplanElectiveCourseElectives":{
  null,
         "iddev":"91f46e39-cea8-422b-b215-00f6bcf5d280",false
      }
   ],
   "firstNameplanElectiveCourses":"John",
[  
      {  
         "lastNameid":"Doe"
         }c0a80097-56da-132c-8156-db0381b6001d",
         "modifiedDatecreatedDate":"1331269200000"1472553255350,
         "modifiedBycreatedBy":{  
            "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
            "firstName":"JohnAmy",
            "lastName":"DoeAdministrator",
             },"fullName":"Amy Administrator"
         "objectStatus":"ACTIVE"},
         "personIdmodifiedDate":"b3c888f8-5056-a51a-8061-00a5435f98d9"1472553255350,
         "contactTitlemodifiedBy":"Ms.",{  
            "contactNameid":"Joan Jamesc0a80097-5210-159c-8152-10179f730006",
            "contactPhonefirstName":"(212) 555-1234Amy",
            "contactEmaillastName":"john.james@hkjhfe.comAdministrator",
            "contactNotesfullName":"CallAmy before NoonAdministrator",
         "isAccepted":true},
         "planNameobjectStatus":"John Doe's Path To SuccessACTIVE",
         "dateAcceptedcourseCode":"1331269200000HST-201",
         "totalTermCreditHoursformattedCourse":105"HST201",
         "isOnPlancourseTitle":false"U.S. History I",
         "studentNotescourseDescription":"Summer classes may help complete Course: HST201 is not currently offered in the programselected quickerterm.",
         "isPledgecreditHours":false3.00,
         "academicGoalplanElectiveCourseElectives":"Graduate[ from a
4 year university",          "offPlanReason":"John had to pick up extra hours at work.",{  
               "isFinancialAidid":true,"c0a80097-56da-132c-8156-db0381b6001e",
               "isImportantcreatedDate":true1472553255350,
               "isF1VisacreatedBy":false,{  
        "career":"http://www.careers.com/dental_hygenist",          "academicid":"http://www.academics.com/dental_hygenist_classes"
      }c0a80097-5210-159c-8152-10179f730006",
   ]
}

Get Full Plan (MAP)

Description

Paginated collection of all plan details for {person-uuid}, regardless of object_status

Method

GET /ssp/api/1/person/{person-uuid}/map/plan/full

Security

TBD

Returns

Code Block
{       "success":"true",    "results":1,    "rowsfirstName":["Amy",
        {          "idlastName":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",Administrator",
                  "createdDatefullName":"1331269200000",Amy Administrator"
               },
  "createdBy":{             "idmodifiedDate":"91f46e39-cea8-422b-b215-00f6bcf5d280",1472553255350,
               "modifiedBy":{  
     "firstName":"John",             "lastNameid":"Doe"c0a80097-5210-159c-8152-10179f730006",
         },
         "modifiedDatefirstName":"1331269200000Amy",
  
      "modifiedBy":{             "idlastName":"91f46e39-cea8-422b-b215-00f6bcf5d280Administrator",
            "firstName      "fullName":"JohnAmy Administrator",
            "lastName":"Doe"   },
      },          "objectStatus":"ACTIVE",
    
    "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",           "contactTitlecourseCode":"Ms.HST-163",
               "contactNameformattedCourse":"Joan JamesHST163",
               "contactPhonecourseTitle":"(212) 555-1234",Fundamentals of History",
               "contactEmailcourseDescription":"john.james@hkjhfe.comFundamentals of History",
         "contactNotes":"Call before Noon",    "creditHours":4.00,
     "isAccepted":true,          "planNameplanElectiveCourseId":"John Doe's Path To Success","c0a80097-56da-132c-8156-db0381b6001d"
            "dateAccepted":"1331269200000"},
         "totalTermCreditHours":105,   {  
     "isOnPlan":false,          "studentNotesid":"Summer classes may help complete the program quicker","c0a80097-56da-132c-8156-db0381b6001f",
               "isPledgecreatedDate":false1472553255350,
         "academicGoal      "createdBy":"Graduate{ from a
4 year university",          "offPlanReason":"John had to pick up extra hours at work. "id":"c0a80097-5210-159c-8152-10179f730006",
         "isFinancialAid":true,          "isImportantfirstName":true"Amy",
         "isF1Visa":false,          "careerlastName":"http://www.careers.com/dental_hygenistAdministrator",

        "academic":"http://www.academics.com/dental_hygenist_classes",          "planCoursesfullName":["Amy Administrator"
               {},
               "idmodifiedDate":"ce0d041d-d3ac-42a1-9085-7f744240e07e"1472553255350,
               "createdDatemodifiedBy":"1331269200000",{  
                  "createdByid":{"c0a80097-5210-159c-8152-10179f730006",
                  "idfirstName":"91f46e39-cea8-422b-b215-00f6bcf5d280Amy",
                  "firstNamelastName":"JohnAdministrator",
                  "lastNamefullName":"DoeAmy Administrator"
               },
               "modifiedDateobjectStatus":"1331269200000ACTIVE",
               "modifiedBycourseCode":{
  "HST-198",
               "idformattedCourse":"91f46e39-cea8-422b-b215-00f6bcf5d280HST198",
                  "firstNamecourseTitle":"JohnEnterprise History",
  
               "lastNamecourseDescription":"DoeEnterprise History",
                }"creditHours":4.00,
               "objectStatusplanElectiveCourseId":"ACTIVE",c0a80097-56da-132c-8156-db0381b6001d"
               "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9",
               "courseId":"BIO128",
      }
....

 

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":{  
      "orderid":1"c0a80097-5210-159c-8152-10179f730006",
               "courseLabel"firstName":"BIO 128Amy",
  
            "maxCreditHours":5,
               "totalCreditHours":5"lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "changedCreditHoursmodifiedDate":01481743969877,
   "modifiedBy":{  
         "isTranscriptid":true"c0a80097-5210-159c-8152-10179f730006",
        "firstName":"Amy",
      "noteslastName":"ThisAdministrator",
 class can be difficult if you haven't taken BIO in HS" "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
      "name":"Testing Non-Course Requisite",
    "notesForAdvisorownerId":"Advise student to brush up on HS BIOc0a80097-5210-159c-8152-10179f730006",
   "ownerName":"Amy Administrator",
   "ownerEmail":"amy.administrator@university.edu",
   "contactTitle":"Academic Advisor",
      "isCriticalcontactName":true"Amy Administrator",
   "contactPhone":"",
           "isPElective":false"contactEmail":"amy.administrator@university.edu",
     "contactNotes":"",
     "catalogYearCode":"",
   "courseTypeIdstudentNotes":"b3c888f8-5056-a51a-8061-00a5435f98d9",
   "isFinancialAid":false,
   "isImportant":false,
   "isF1Visa":false,
   "termCodeacademicGoals":"FA-13",
   "academicLink":"",
   "careerLink":"",
   "isValid":false,
}   "termNotes":[  
    ],
   "programCode":"",
   "personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
   "termNotesbasedOnTemplateId":[null,
   "planCourses":[  
      {
  
            "id":"ce0d041dc0a80097-d3ac58fe-42a11d97-90858158-7f744240e07efed2ae450002",
               "createdDate":"1331269200000",
     1481743969860,
         "createdBy":{
     
            "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
                  "firstName":"JohnAmy",
                  "lastName":"DoeAdministrator",
            "fullName":"Amy Administrator"
   },      },
         "modifiedDate":"1331269200000",
     1481743969860,
         "modifiedBy":{
     
            "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
                  "firstName":"JohnAmy",
   
              "lastName":"DoeAdministrator",
            "fullName":"Amy Administrator"
   },      },
         "isCriticalobjectStatus":false"ACTIVE",
         "termCode":"FA2017",
         "termCodecourseCode":"FAAES-13118",
     
         "notesformattedCourse":"John is also working full time this semester",AES118",
         "courseTitle":"General Aerospace",
         "termNotesForAdvisorscourseDescription":"JohnGeneral isAerospace",
at risk because of outside commitments"    "studentNotes":"",
        } "contactNotes":"",
        ]
  "isImportant":false,
    }    ]
}

 

Get Full Plan (MAP)- Active Plan

Description

Paginated collection, but containing only the current active plan for {person-uuid}

Method

GET /ssp/api/1/person/{person-uuid}/map/plan/full?status=ACTIVE

Security

TBD

Returns

Code Block
{ "isTranscript":false,
         "successelectiveId":"true",null,
         "electiveName":null,
         "resultselectiveCode":1null,
   "rows":[      "creditHours":3.00,
         {"isDev":false,
         "idorderInTerm":"58ba5ee3-734e-4ae9-b9c5-943774b4de41"0,
         "planToOffer":null,
         "createdDateisValidInTerm":"1331269200000"false,
         "createdByduplicateOfTranscript":{
  false,
         "idhasPrerequisites":"91f46e39-cea8-422b-b215-00f6bcf5d280",
  false,
         "firstNamehasCorequisites":"John",
  false,
         "lastNameinvalidReasons":"Doe"Course: AES118 is not currently offered in the selected  },
         "modifiedDate":"1331269200000term. Pre/co requisite + AES099 is missing.",
         "modifiedBy":{
  personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
         "idoriginalFormattedCourse":"91f46e39-cea8-422b-b215-00f6bcf5d280",
 null,
          "firstNameplanElectiveCourseElectives":"John"null,
            "lastNamedev":"Doe"false
      }
   },],
   "planElectiveCourses":[  
      {  "objectStatus":"ACTIVE",
         "personIdid":"b3c888f8c0a80097-505656da-a51a132c-80618156-00a5435f98d9db0381b6001d",
         "contactTitlecreatedDate":"Ms."1472553255350,
         "contactNamecreatedBy":"Joan James",{  
            "contactPhoneid":"(212) 555-1234c0a80097-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":"1331269200000"1472553255350,
         "totalTermCreditHoursmodifiedBy":105,{  
            "isOnPlanid":false,
   "c0a80097-5210-159c-8152-10179f730006",
     "studentNotes":"Summer classes may help complete the program quicker "firstName":"Amy",
            "isPledgelastName":false,"Administrator",
            "academicGoalfullName":"Graduate from a 4 year university"Amy Administrator"
         },
         "offPlanReasonobjectStatus":"ACTIVE"John,
  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  "career":"http://www.careers.com/dental_hygenistselected term.",
         "academiccreditHours":"http://www.academics.com/dental_hygenist_classes"3.00,
         "planCoursesplanElectiveCourseElectives":[  
            {  
               "id":"ce0d041dc0a80097-d3ac56da-42a1132c-90858156-7f744240e07edb0381b6001e",
               "createdDate":"1331269200000"1472553255350,
               "createdBy":{  
                  "id":"91f46e39c0a80097-cea85210-422b159c-b215-00f6bcf5d2808152-10179f730006",
                  "firstName":"Amy",
                  "firstNamelastName":"JohnAdministrator",
                  "lastNamefullName":"DoeAmy Administrator"
               },
               "modifiedDate":"1331269200000"1472553255350,
               "modifiedBy":{  
                  "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
                  "firstName":"JohnAmy",
                  "lastName":"Doe"
           Administrator",
   },                "objectStatusfullName":"ACTIVEAmy Administrator",
               "personId":"b3c888f8-5056-a51a-8061-00a5435f98d9"},
               "courseIdobjectStatus":"BIO128ACTIVE",
               "ordercourseCode":1"HST-163",
               "courseLabelformattedCourse":"BIO 128HST163",
               "maxCreditHours":5"courseTitle":"Fundamentals of History",
               "totalCreditHourscourseDescription":5"Fundamentals of History",
               "changedCreditHourscreditHours":04.00,
               "isTranscriptplanElectiveCourseId":true,"c0a80097-56da-132c-8156-db0381b6001d"
            },
   "notes":"This class can be difficult if you haven't taken BIO{ in HS",
               "notesForAdvisorid":"Advise student to brush up on HS BIO",c0a80097-56da-132c-8156-db0381b6001f",
               "createdDate":1472553255350,
      "isCritical":true,          "createdBy":{  
   "isPElective":false,                "courseTypeIdid":"b3c888f8c0a80097-50565210-a51a159c-80618152-00a5435f98d910179f730006",
                  "termCodefirstName":"FA-13"Amy",
                 }
 "lastName":"Administrator",
        ],          "termNotesfullName":["Amy Administrator"
               {},
               "idmodifiedDate":"ce0d041d-d3ac-42a1-9085-7f744240e07e"1472553255350,
               "createdDatemodifiedBy":"1331269200000",{  
                  "createdBy":{"id":"c0a80097-5210-159c-8152-10179f730006",
                  "idfirstName":"91f46e39-cea8-422b-b215-00f6bcf5d280Amy",
                  "firstNamelastName":"JohnAdministrator",
                  "lastNamefullName":"DoeAmy Administrator"
               },
               "modifiedDateobjectStatus":"1331269200000ACTIVE",
               "modifiedBycourseCode":{
  "HST-198",
               "idformattedCourse":"91f46e39-cea8-422b-b215-00f6bcf5d280HST198",
                  "firstNamecourseTitle":"JohnEnterprise History",
 
                "lastNamecourseDescription":"DoeEnterprise History",
               }"creditHours":4.00,
               "isCriticalplanElectiveCourseId":false,
"c0a80097-56da-132c-8156-db0381b6001d"
            }
 "termCode":"FA-13",        ]
      }
"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