Versions Compared

Old Version 20

changes.mady.by.user Jason Elwood

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":109,
   "rows":[  
      {  
         "id":"0a90940ac0a80097-3efe5637-152011d3-813f8156-00be6828005a3776d34a0004",
         "createdDate":13701070459281469809349450,
         "createdBy":{  
            "id":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b10179f730006",
            "firstName":"Amy",
            "lastName":"Administrator",
        },         "modifiedDatefullName":1370966161353,"Amy Administrator"
       "modifiedBy":{  },
          "id":"0a90940a-3efc-175f-813e-fc1ac581000bmodifiedDate":1469809349450,
         "modifiedBy":{  
            "id":"c0a80097-5210-159c-8152-10179f730006",
            "firstName":"Amy",
            "lastName":"Administrator",
            "fullName":"Amy Administrator"
         },
         "objectStatus":"ACTIVEINACTIVE",
         "name":"PlanTesting SSP3155 foron Graduation7/29",
         "ownerId":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b10179f730006",
         "ownerName":"Amy Administrator",
         "ownerEmail":"amy.administrator@university.edu",
         "contactTitle":"MrAcademic Advisor",
         "contactName":"MikeAmy SmithAdministrator",
         "contactPhone":"212-555-1212",
         "contactEmail":"advisor@institutionamy.administrator@university.edu",
         "contactNotes":"Advisor Notes"",
         "catalogYearCode":"",
         "studentNotes":"Student Notes",
         "isFinancialAid":truefalse,
         "isImportant":truefalse,
         "isF1Visa":truefalse,
         "academicGoals":"Goal",
         "academicLink":"academic link",
         "careerLink":"career link",
         "isValid":true,
         "termNotes":[  

         ],
         "programCode":"CST-AS",
         "personId":"64a9772917b082d1-79995a84-4b314fe3-b70b88ad-f0b705dff288c54e225821c7",
         "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
{
   "success":"true",
   "results":10,
   "rows":[
   {
   "id":"0a90940a-3fc7-1f00-813f-ca10fee70002",
   "createdDate":1373484678888,
   "createdBy":{
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator"
   },
   "modifiedDate":1373484778372,
   "modifiedBy":{,
      {  
         "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,
         "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":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b10179f730006",
            "firstName":"Amy",
            "lastName":"Administrator",
   },     "objectStatus":"ACTIVE",    "namefullName":"SampleAmy Plan",Administrator"
       "ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b",  },
    "ownerName":"Amy Administrator",    "contactTitlemodifiedDate":"Advisor"1472553255350,
   "contactName":"John Smith",      "contactPhonemodifiedBy":"212-555-1212",{  
  "contactEmail":"advisor@college.edu",    "contactNotes":"Advisor Plan Notes",    "studentNotesid":"Student Plan Notesc0a80097-5210-159c-8152-10179f730006",
    "isFinancialAid":true,    "isImportant":true,    "isF1VisafirstName":true,"Amy",
      "academicGoals":"Goals for Academics",    "academicLinklastName":"http://www.college.edu/academic.htmlAdministrator",
      "careerLink":"http://www.college.edu/career.html",      "isValidfullName":true,"Amy Administrator"
  "termNotes":[       {},
         "idobjectStatus":"0a90940a-3efc-175f-813e-fc1ac581000bACTIVE",
         "firstNamecourseCode":"AmyHST-201",
         "lastNameformattedCourse":"AdministratorHST201",
      },    "objectStatuscourseTitle":"ACTIVEU.S. History I",
   "studentNotes":"Student Term Notes",    "contactNotescourseDescription":"Advisor Term Notes",
   "termCode":"FA2013",
   "isImportant":true}Course: HST201 is not currently offered in the selected term.",
   "planCourses":[       {"creditHours":3.00,
         "id":"0a90940a-3fc7-1f00-813f-ca1283680016","planElectiveCourseElectives":[  
       "createdDate":1373484778344,     {  
  "createdBy":{             "id":"0a90940ac0a80097-3efc56da-175f132c-813e8156-fc1ac581000bdb0381b6001e",
               "firstNamecreatedDate":"Amy"1472553255350,
               "lastNamecreatedBy":"Administrator"},{  
    "modifiedDate":1373484778344,       "modifiedBy":{
         "id":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b10179f730006",
                  "firstName":"Amy","Amy",
                  "lastName":"Administrator"},
        "objectStatus":"ACTIVE",          "termCodefullName":"FA2013",Amy Administrator"
        "courseCode":"IEE-105",       "formattedCourse":"IEE105"},
      "courseTitle":"Analytical Industrial Engineering",       "courseDescriptionmodifiedDate":" "1472553255350,
      "studentNotes":"Advisor Student Notes",       "contactNotesmodifiedBy":"Advisor Course Notes",{  
    "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":""} 	 },
... 	]
}

 

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
{              "idobjectStatus":"0a90940a-3fc7-1f00-813f-ca10fee70002ACTIVE",
    "createdDate":1373484678888,    "createdBy":{       "idcourseCode":"0a90940a-3efc-175f-813e-fc1ac581000bHST-163",
       "firstName        "formattedCourse":"AmyHST163",
      "lastName":"Administrator"     },    "modifiedDatecourseTitle":1373484778372,"Fundamentals of History",
        "modifiedBy":{       "idcourseDescription":"0a90940a-3efc-175f-813e-fc1ac581000bFundamentals of History",
        "firstName":"Amy",       "lastNamecreditHours":"Administrator"4.00,
   },    "objectStatus":"ACTIVE",    "name":"Sample Plan",    "ownerIdplanElectiveCourseId":"0a90940ac0a80097-3efc56da-175f132c-813e8156-fc1ac581000b",db0381b6001d"
           "ownerName":"Amy Administrator", },
       "contactTitle":"Advisor",    "contactName":"John Smith", {  
 "contactPhone":"212-555-1212",    "contactEmail":"advisor@college.edu",    "contactNotes":"Advisor Plan Notes",    "studentNotesid":"Student Plan Notesc0a80097-56da-132c-8156-db0381b6001f",
   "isFinancialAid":true,    "isImportant":true,    "isF1Visa":true,    "academicGoalscreatedDate":"Goals for Academics",1472553255350,
       "academicLink":"http://www.college.edu/academic.html",    "careerLink":"http://www.college.edu/career.html",    "isValidcreatedBy":true,{  
 "termNotes":[       {          "id":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b10179f730006",
                  "firstName":"Amy",,
                  "lastName":"Administrator",
          },    "objectStatus":"ACTIVE",    "studentNotesfullName":"Amy Administrator"Student
Term Notes",    "contactNotes":"Advisor Term Notes",    "termCode":"FA2013",    "isImportant":true},
   "planCourses":[       {     "modifiedDate":1472553255350,
    "id":"0a90940a-3fc7-1f00-813f-ca1283680016",           "createdDatemodifiedBy":1373484778344,{  
       "createdBy":{             "id":"0a90940ac0a80097-3efc5210-175f159c-813e8152-fc1ac581000b10179f730006",
            "firstName":"Amy",             "lastNamefirstName":"AdministratorAmy"},
      "modifiedDate":1373484778344,       "modifiedBy":{          "idlastName":"0a90940a-3efc-175f-813e-fc1ac581000bAdministrator",
         "firstName":"Amy",          "lastNamefullName":"Amy Administrator"},
        "objectStatus":"ACTIVE",       "termCode":"FA2013",},
        "courseCode":"IEE-105",       "formattedCourseobjectStatus":"IEE105ACTIVE",
      "courseTitle":"Analytical Industrial Engineering",       "courseDescriptioncourseCode":" HST-198",
      "studentNotes":"Advisor Student Notes",       "contactNotesformattedCourse":"Advisor Course NotesHST198",
      "isImportant":true,       "isTranscript":false,       "electiveIdcourseTitle":"3bdda584-f7a2-4402-8863-4b5bd8273009Enterprise History",
        "creditHours":2.00,       "isDevcourseDescription":true"Enterprise History",
       "orderInTerm":1,        "planToOffercreditHours":null4.00,
       "personId":"64a97729-7999-4b31-b70b-f0b705dff288",        "duplicateOfTranscriptplanElectiveCourseId":false,"c0a80097-56da-132c-8156-db0381b6001d"
      "dev":true,      }
"isValidInTerm":true,       "hasPrerequisites":true,  ]
    "hasCorequisites":true,   }
   "invalidReasons":""}]
}

Print or Email (MAP)

Description
Prints or emails the active plan details for {person-uuid}

...