Versions Compared

Key

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

...

 

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":"Administrator",
            "fullName":"DoeAmy 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 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",,
         "programCode":"CST-AS",
         "resultspersonId":1,"17b082d1-5a84-4fe3-88ad-c54e225821c7",
         "rowscourses":[null
      },
      {  
         "id":"58ba5ee3c0a80097-734e5668-4ae91662-b9c58156-943774b4de416aea950f001b",
         "createdDate":13312692000001470672573710,
         "createdBy":{  
            "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
            "firstName":"JohnAmy",
            "lastName":"Doe"Administrator",
            "fullName":"Amy Administrator"
         },
         "modifiedDate":13312692000001470672573710,
         "modifiedBy":{  
            "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",
            "firstName":"JohnAmy",
            "lastName":"Administrator",
            "fullName":"DoeAmy Administrator"
         },
         "objectStatus":"ACTIVEINACTIVE",
         "personIdname":"b3c888f8-5056-a51a-8061-00a5435f98d9Just for Paul",
         "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 Success"amy.administrator@university.edu",
         "contactNotes":"",
         "isOnPlancatalogYearCode":false"",
         "studentNotes":""Summer,
   classes may help complete the program quicker"isFinancialAid":false,
         "academicGoalsisImportant":"Graduate from a 4 year university"false,
         "isF1Visa":false,
         "offPlanReasonacademicGoals":"John had to pick up extra hours at work.",
         "isFinancialAid":true,
"",
         "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":{  
      "isImportantid":true,
  "c0a80097-5210-159c-8152-10179f730006",
      "isF1VisafirstName":false,
  "Amy",
      "careerLinklastName":"http://www.careers.com/dental_hygenistAdministrator",
         "academicLinkfullName":"http://www.academics.com/dental_hygenist_classes",
Amy Administrator"
    },
   "planCoursesmodifiedDate":[1481743969877,
   "modifiedBy":{  
      {"id":"c0a80097-5210-159c-8152-10179f730006",
        "firstName":"Amy",
      "idlastName":"ce0d041d-d3ac-42a1-9085-7f744240e07eAdministrator",
      "fullName":"Amy Administrator"
   },
   "createdDateobjectStatus":1331269200000"ACTIVE",
   "name":"Testing Non-Course Requisite",
     "ownerId":"c0a80097-5210-159c-8152-10179f730006",
    "createdByownerName":{"Amy Administrator",
   "ownerEmail":"amy.administrator@university.edu",
   "contactTitle":"Academic Advisor",
   "contactName":"Amy Administrator",
   "idcontactPhone":"91f46e39-cea8-422b-b215-00f6bcf5d280",
   "contactEmail":"amy.administrator@university.edu",
   "contactNotes":"",
     "catalogYearCode":"",
    "firstNamestudentNotes":"John",
      "isFinancialAid":false,
   "isImportant":false,
   "isF1Visa":false,
   "lastNameacademicGoals":"Doe",
   "academicLink":"",
   "careerLink":"",
       }"isValid":false,
   "termNotes":[  
   ],
     "modifiedDateprogramCode":1331269200000"",
   "personId":"17b082d1-5a84-4fe3-88ad-c54e225821c7",
      "basedOnTemplateId":null,
    "modifiedByplanCourses":{[  
      {  
         "id":"91f46e39c0a80097-cea858fe-422b1d97-b2158158-00f6bcf5d280fed2ae450002",
         "createdDate":1481743969860,
         "firstNamecreatedBy":"John",
  {  
             "lastNameid":"Doe"c0a80097-5210-159c-8152-10179f730006",
               },
 "firstName":"Amy",
             "objectStatuslastName":"ACTIVEAdministrator",
  
            "personIdfullName":"b3c888f8-5056-a51a-8061-00a5435f98d9",Amy Administrator"
         },
     "courseCode":"BIO128_12345"      "modifiedDate":1481743969860,
         "formattedCoursemodifiedBy":"BIO128",
{  
            "courseTitleid":"Cell Biologyc0a80097-5210-159c-8152-10179f730006",
  
            "courseDescriptionfirstName":"Cell Biology Description", 
			   "orderInTerm":1,
  Amy",
            "creditHourslastName":5,
  "Administrator",
            "isTranscriptfullName":true,"Amy Administrator"
         },
    "studentNotes":"This class can be difficult if you haven't taken BIO in HS",
      "objectStatus":"ACTIVE",
         "contactNotestermCode":"Advise student to brush up on HS BIO"FA2017",
         "courseCode":"AES-118",
         "formattedCourse":"AES118",
     "isImportant":true,      "courseTitle":"General Aerospace",
         "isDevcourseDescription":true,"General Aerospace",
         "studentNotes":"",
        "electiveIds":[ {"idcontactNotes":"1d93a1b5-a2d9-11e2-8d55-406c8f22c3ce"},
          "isImportant":false,
          "isTranscript":false,
         {"id":"2b69aff5-a2d9-11e2-a881-406c8f22c3ce") ],electiveId":null,
         "electiveName":null,
         "termCodeelectiveCode":"FA-13"null,
         "creditHours":3.00,
  }          ]"isDev":false,
         "termNotesorderInTerm":[0,
         "planToOffer":null,
  {       "isValidInTerm":false,
         "id":"ce0d041d-d3ac-42a1-9085-7f744240e07e",duplicateOfTranscript":false,
         "hasPrerequisites":false,
         "createdDatehasCorequisites":1331269200000false,
         "invalidReasons":"Course: AES118 is not currently offered "createdBy":{in the selected term. Pre/co requisite + AES099 is missing.",
         "idpersonId":"91f46e3917b082d1-cea85a84-422b4fe3-b21588ad-00f6bcf5d280c54e225821c7",
         "originalFormattedCourse":null,
         "firstNameplanElectiveCourseElectives":"John"null,
         "dev":false
      }
   "lastName],
   "planElectiveCourses":"Doe"
[  
      {  
   },      "id":"c0a80097-56da-132c-8156-db0381b6001d",
         "modifiedDatecreatedDate":13312692000001472553255350,
    
          "modifiedBycreatedBy":{
    
             "id":"91f46e39c0a80097-cea85210-422b159c-b2158152-00f6bcf5d28010179f730006",

                 "firstName":"JohnAmy",
            "lastName":"Administrator",
            "lastNamefullName":"Doe"Amy Administrator"
         },
         },
"modifiedDate":1472553255350,
         "modifiedBy":{  
            "objectStatusid":"ACTIVE"
  c0a80097-5210-159c-8152-10179f730006",
            "isImportantfirstName":false,
  "Amy",
            "termCodelastName":"FA-13Administrator",
  
            "studentNotesfullName":"JohnAmy isAdministrator"
also working full time this semester",      },
         "contactNotesobjectStatus":"ACTIVE"John,
is at risk because of outside commitments"   "courseCode":"HST-201",
         }
    "formattedCourse":"HST201",
    ]     "courseTitle":"U.S.  }
 History I",
 ]
}

 

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
{        "idcourseDescription":"0a90940a-3fc7-1f00-813f-ca10fee70002", Course: HST201 is not currently offered in the selected term.",
         "createdDatecreditHours":13734846788883.00,

  "createdBy":{       "idplanElectiveCourseElectives":"0a90940a-3efc-175f-813e-fc1ac581000b",[  
    "firstName":"Amy",       "lastName":"Administrator" {  
},    "modifiedDate":1373484778372,    "modifiedBy":{       "id":"0a90940ac0a80097-3efc56da-175f132c-813e8156-fc1ac581000bdb0381b6001e",
               "firstNamecreatedDate":"Amy",1472553255350,
               "lastNamecreatedBy":"Administrator"{  
     },    "objectStatus":"ACTIVE",    "name":"Sample Plan",    "ownerIdid":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b",10179f730006",
                  "ownerNamefirstName":"Amy Administrator",
                  "contactTitlelastName":"AdvisorAdministrator",
                  "contactNamefullName":"JohnAmy SmithAdministrator",
     "contactPhone":"212-555-1212",    "contactEmail":"advisor@college.edu",    "contactNotes":"Advisor Plan Notes"},
    "studentNotes":"Student Plan Notes",           "isFinancialAidmodifiedDate":true1472553255350,
       "isImportant":true,    "isF1Visa":true,    "academicGoalsmodifiedBy":"Goals for Academics",{  
      "academicLink":"http://www.college.edu/academic.html",    "careerLink":"http://www.college.edu/career.html",    "isValid":true,    "termNotes":["id":"c0a80097-5210-159c-8152-10179f730006",
        {          "idfirstName":"0a90940a-3efc-175f-813e-fc1ac581000bAmy",

        "firstName":"Amy",          "lastName":"Administrator"
,
     },    "objectStatus":"ACTIVE",    "studentNotes":"Student Term Notes",    "contactNotesfullName":"Amy Administrator"Advisor
 Term Notes",    "termCode":"FA2013",    "isImportant":true},    "planCourses":[ },
     {          "idobjectStatus":"0a90940a-3fc7-1f00-813f-ca1283680016ACTIVE",
         "createdDate":1373484778344,       "courseCode":"HST-163",
  "createdBy":{             "idformattedCourse":"0a90940a-3efc-175f-813e-fc1ac581000bHST163",
               "firstNamecourseTitle":"AmyFundamentals of History",
               "lastNamecourseDescription":"AdministratorFundamentals of History"},,
               "modifiedDatecreditHours":13734847783444.00,
      "modifiedBy":{          "idplanElectiveCourseId":"0a90940ac0a80097-3efc56da-175f132c-813e-fc1ac581000b",
 8156-db0381b6001d"
       "firstName":"Amy",      },
   "lastName":"Administrator"},       "objectStatus":"ACTIVE",  {  
  "termCode":"FA2013",       "courseCode":"IEE-105",       "formattedCourseid":"IEE105c0a80097-56da-132c-8156-db0381b6001f",
      "courseTitle":"Analytical Industrial Engineering",       "courseDescriptioncreatedDate":" "1472553255350,
      "studentNotes":"Advisor Student Notes",       "contactNotes":"Advisor Course Notes","createdBy":{  
    "isImportant":true,       "isTranscript":false,       "electiveIdid":"3bdda584c0a80097-f7a25210-4402159c-88638152-4b5bd827300910179f730006",
 
    "creditHours":2.00,       "isDev":true,       "orderInTermfirstName":1"Amy",
      "planToOffer":null,       "personId":"64a97729-7999-4b31-b70b-f0b705dff288",
      "duplicateOfTranscriptlastName":false"Administrator",
      "dev":true,
      "isValidInTerm":true,         "hasPrerequisitesfullName":true,"Amy Administrator"
        "hasCorequisites":true,       "invalidReasons":""}],
 
 "courses":[       {       "idmodifiedDate":"0a90940a-3fc7-1f00-813f-ca1283680016",1472553255350,
        "createdDate":1373484778344,       "createdBymodifiedBy":{  
        "id":"0a90940a-3efc-175f-813e-fc1ac581000b",          "firstNameid":"Amyc0a80097-5210-159c-8152-10179f730006",
         "lastName":"Administrator"},         "modifiedDatefirstName":1373484778344"Amy",
        "modifiedBy":{          "idlastName":"0a90940a-3efc-175f-813e-fc1ac581000b",Administrator",
                  "firstNamefullName":"Amy", Administrator"
               "lastName":"Administrator"},
       "objectStatus":"ACTIVE",        "termCodeobjectStatus":"FA2013ACTIVE",
      "courseCode":"IEE-105",         "formattedCoursecourseCode":"IEE105HST-198",
      "courseTitle":"Analytical Industrial Engineering",       "courseDescriptionformattedCourse":" HST198",
      "studentNotes":"Advisor Student Notes",       "contactNotescourseTitle":"AdvisorEnterprise Course NotesHistory",
        "isImportant":true,       "isTranscriptcourseDescription":false"Enterprise History",
       "electiveId":"3bdda584-f7a2-4402-8863-4b5bd8273009",        "creditHours":24.00,
               "isDevplanElectiveCourseId":true,"c0a80097-56da-132c-8156-db0381b6001d"
         "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