Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

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.
Method
GET /ssp/api/1/person/{person-uuid}/map/plan/summary

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

{
"success":"true",
"message":"",
"results":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

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

{
   "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
GET /ssp/api/1/person/{person-uuid}/map/plan/current

Security

PERSON_MAP_READ

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 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

 

  • No labels