MyGPS API

This API is available starting in SSP v2.0

Get Current Plan (MyGPS)

Description

Displays the active plan for the student user in MyGPS. See API notes for status parameter handling handling.

Method

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

Security

ROLE_MY_GPS_TOOL

Returns

{
   "id":"0a90940a-3fc7-1f00-813f-ca10fee70002",
   "createdDate":1373484678888,
   "createdBy":{
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator"
   },
   "modifiedDate":1373484778372,
   "modifiedBy":{
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator"
   },
   "objectStatus":"ACTIVE",
   "name":"Sample Plan",
   "ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "ownerName":"Amy Administrator",
   "contactTitle":"Advisor",
   "contactName":"John Smith",
   "contactPhone":"212-555-1212",
   "contactEmail":"advisor@college.edu",
   "contactNotes":"Advisor Plan Notes",
   "studentNotes":"Student Plan Notes",
   "isFinancialAid":true,
   "isImportant":true,
   "isF1Visa":true,
   "academicGoals":"Goals for Academics",
   "academicLink":"http://www.college.edu/academic.html",
   "careerLink":"http://www.college.edu/career.html",
   "isValid":true,
   "termNotes":[
      {
         "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
         "firstName":"Amy",
         "lastName":"Administrator"
      },
   "objectStatus":"ACTIVE",
   "studentNotes":"Student Term Notes",
   "contactNotes":"Advisor Term Notes",
   "termCode":"FA2013",
   "isImportant":true},
   "planCourses":[
      {
         "id":"0a90940a-3fc7-1f00-813f-ca1283680016",
         "createdDate":1373484778344,
         "createdBy":{
            "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
      "modifiedDate":1373484778344,
      "modifiedBy":{
         "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
         "firstName":"Amy",
         "lastName":"Administrator"},
      "objectStatus":"ACTIVE",
      "termCode":"FA2013",
      "courseCode":"IEE-105",
      "formattedCourse":"IEE105",
      "courseTitle":"Analytical Industrial Engineering",
      "courseDescription":" ",
      "studentNotes":"Advisor Student Notes",
      "contactNotes":"Advisor Course Notes",
      "isImportant":true,
      "isTranscript":false,
      "electiveId":"3bdda584-f7a2-4402-8863-4b5bd8273009",
      "creditHours":2.00,
      "isDev":true,
      "orderInTerm":1,
      "planToOffer":null,
      "personId":"64a97729-7999-4b31-b70b-f0b705dff288",
      "duplicateOfTranscript":false,
      "dev":true,
      "isValidInTerm":true,
      "hasPrerequisites":true,
      "hasCorequisites":true,
      "invalidReasons":""}]
}

Print Current Plan (MyGPS)

Description

Displays the current plan in the printable html format. See API notes for status parameter handling handling.

Method

GET /ssp/api/1/mygps/plan/print

Security

ROLE_MY_GPS_TOOL

Returns

HTML formatted plan based on the message template define for MAP Plan Printout