Versions Compared

Old Version 1

changes.mady.by.user Jason Elwood

Saved on

compared with

New Version 2

changes.mady.by.user Jason Elwood

Saved on

Key

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

 

Get a Plan (MAP)

...

Status

 

Description

Two methods are available to store the Plan status in SSP.  The calculation can be made by SSP or provided in the external data.  Each has a separate API for accessing the information (GET).  The external data only accepts a GET method.  The SSP calculated data accepts each method described below.  Paginated collection of all plan summaries for {person-uuid}, optionally filtered by status. See API notes for status parameter handling handling.

MethodMethods
External Data:  GET /ssp/api/1/person/{person-uuidid}/map/plan/planstatus

SSP Data: GET /ssp/api/1/person/{id}/map/plan/summarycalculatedPlanstatus

Security

PERSON_MAP_READParameters

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

Returns

Code Block
{
"successschoolId":"truejwilson219",
"messagestatus":"ON",
"resultsstatusReason":10,"rows":[     {
        "id":"0a90940a-3efe-1520-813f-00be6828005a",
        "createdDate":1370107045928,
        "createdBy":{
            "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"
        },
        "modifiedDate":1370966161353,
        "modifiedBy":{
            "id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"
        },
        "objectStatus":"ACTIVE",
        "name":"Plan for Graduation",
        "ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b",
        "ownerName":"Amy Administrator",
        "contactTitle":"Mr",
        "contactName":"Mike Smith",
        "contactPhone":"212-555-1212",
        "contactEmail":"advisor@institution.edu",
        "contactNotes":"Advisor Notes",
        "studentNotes":"Student Notes",
        "isFinancialAid":true,
        "isImportant":true,
        "isF1Visa":true,
        "academicGoals":"Goal",
        "academicLink":"academic link",
        "careerLink":"career link",
        "isValid":true,
        "termNotes":[],
        "personId":"64a97729-7999-4b31-b70b-f0b705dff288",
        "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

...

}

 

Create a Plan (MAP) Status

SSP Data: POST /ssp/api/1/person/{person-uuidid}/map/plan/calculatedPlanstatus

External Data: None

Security

PERSON_MAP_READWRITE

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":"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":""}
	  ...
	]
}

 

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

...

Sample Post

Code Block
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}

Returns

Code Block
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}

 

Save a Plan (MAP) Status

SSP Data: PUT /ssp/api/1/person/{id}/map/plan/calculatedPlanstatus

External Data: None

Security

PERSON_MAP_WRITE

Sample Post

Code Block
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}

Returns

Code Block
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}

 

Delete a Plan (MAP) Status

SSP Data: DELETE /ssp/api/1/person/{

...

id}/map/plan/

...

calculatedPlanstatus

External Data: None

Security

PERSON_MAP_

...

WRITE

Returns

Code Block
{
   "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 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

...

"success" : "true"}

or

Code Block
{"success" : "false", 
 "message" : "Message when success is false."}