Page Comparison

...

Paginated collection of all plan summaries for {person-uuid}template summaries\, optionally filtered by status. See API notes for status parameter handling handling.

Method

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

Security

PERSON_MAP_READ

Parameters

isPrivate: true,false

divisionCode:

programCode:

departmentCode:

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":101,
"rows":[
    {
        {"id":"0a90940a-3efe3f0c-15201fe9-813f-00be6828005a0c6439ea00e5",
  
     "createdDate":13701070459281370302462442,
        "createdBy":{
            
{"id":"0a90940a30acbb3b-3efc4f5e-175f490b-813e8652-fc1ac581000be1f32a93718f",
        
   "firstName":"AmyRichard",
  
         "lastName":"Administrator"
        },
        Thompson"},
"modifiedDate":1370966161353,
       1370302462442,
"modifiedBy":{
            "id":"0a90940a-3efc-175f-813e-fc1ac581000b
{"id":"30acbb3b-4f5e-490b-8652-e1f32a93718f",
            "firstName":"AmyRichard",
   
        "lastName":"Administrator"
        },
        "objectStatus":Thompson"},
"objectStatus":"ACTIVE",
     
  "name":"PlanGeneral Education forUndergraduate GraduationDegree",
 
      "ownerId":"0a90940a30acbb3b-3efc4f5e-175f490b-813e8652-fc1ac581000be1f32a93718f",
    
   "ownerName":"AmyRichard AdministratorThompson",

       "contactTitle":"MrSenior Advisor",
        "contactName":"MikeR. SmithThompson",
    
   "contactPhone":"212-555-1212",
  
     "contactEmail":"advisor@institution.edu",
        "contactNotes":"Advisor Notes",
       
"studentNotes":"Student Notes",
  
     "isFinancialAid":true,
        "isImportant"isImportant":true,
     
  "isF1Visa":truefalse,
   
    "academicGoals":"GoalGraduate bachelors degree.",
   
    "academicLink":"academicUndergraduate linkDegree",
      
 "careerLink":"career linkB.A. Arts",
        "isValid":true,
      
 "termNotes":[],
        "personId":"64a97729-7999-4b31-b70b-f0b705dff288",
        "courses":null }
	...
	"programCode":"",
"divisionCode":"DIV_HA",
"departmentCode":"DEP_AS",
"isPrivate":false,
"courses":null}]
}

Get

...

Template (MAP)

Description

Paginated collection of all plan details for {person-uuid}, optionally filtered by status. See API notes for status parameter handling handling.Template details

Method

GET /ssp/api/1/person/{person-uuid}/reference/map/plan/template/{id}

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

{
   "successid":"true0a90940a-4086-1a71-8140-88c4568b000c",
   "resultscreatedDate":101376684103307,
  
"rowscreatedBy":[
 
 {
   "id":"0a90940a-3fc73efc-1f00175f-813f813e-ca10fee70002fc1ac581000b",
   "createdDatefirstName":1373484678888"Amy",
   "createdBylastName":{
      "Administrator"},
"modifiedDate":1376684103307,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName"firstName":"Amy",
     
"lastName":"Administrator"
   },
   "modifiedDateobjectStatus":1373484778372"INACTIVE",
 
 "modifiedByname":{
      "id"New template",
"ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b",
  
   "firstNameownerName":"Amy Administrator",
  
   "lastNamecontactTitle":"Administrator"
   },
   "objectStatuscontactName":"ACTIVE",
   "namecontactPhone":"Sample Plan",
   "ownerIdcontactEmail":"0a90940a-3efc-175f-813e-fc1ac581000b",
  
"ownerNamecontactNotes":"Amy Administrator",
   "contactTitlestudentNotes":"Advisor",
"isFinancialAid":false,
"isImportant":false,
"isF1Visa":false,
"contactNameacademicGoals":"John Smith",

  "contactPhoneacademicLink":"212-555-1212",
  
"contactEmailcareerLink":"advisor@college.edu",
 
 "contactNotesisValid":"Advisor Plan Notes",
   "studentNotes":"Student Plan Notes",
   "isFinancialAid":true,
   "isImportant":true,
   "isF1Visa":truefalse,
"termNotes":[
{"id":"0a90940a-4086-1a71-8140-88c4568d0015",
"createdDate":1376684103309,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "academicGoalsfirstName":"Goals for AcademicsAmy",
   "academicLinklastName":"http://www.college.edu/academic.html",
   "careerLink":"http://www.college.edu/career.html",
   "isValid":true,
   "termNotes":[
      {
         "id":"Administrator"},
"modifiedDate":1376684103309,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
 
       "firstName":"Amy",
         "lastName":"Administrator"
      },
 
 "objectStatus":"ACTIVE",
   "studentNotes":"Student Term Notesnotes",
 
 "contactNotes":"Advisor Term Notes",
  
"termCode":"FA2013SP2014",
   "isImportant":truefalse}],
   "planCourses":[
      {
         "programCode":"EDU-AA",
"divisionCode":"",
"departmentCode":"",
"isPrivate":false,
"templateCourses":[
{"id":"0a90940a-3fc74086-1f001a71-813f8140-ca128368001688c4568c0014",
        
"createdDate":13734847783441376684103308,
 
       "createdBy":{
            
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
 
          "firstName":"Amy",

           "lastName":"Administrator"},
      "modifiedDate":13734847783441376684103308,
      "modifiedBy":{
         
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
         "firstName""firstName":"Amy",
     
   "lastName":"Administrator"},
 
    "objectStatus":"ACTIVE",
   
  "termCode":"FA2013SU2014",
      "courseCode":"IEEAST-105215",

     "formattedCourse":"IEE105AST215",
     
"courseTitle":"AnalyticalEnterprise Industrial EngineeringAstronomy",
  "courseDescription":"  Course: AST215 "courseDescription":" ",
     is not currently offered in the selected term.",
"studentNotes":"Advisor Student Notes",
      "contactNotes":"Advisor Course Notes",
     
"isImportant":truefalse,
    
 "isTranscript":false,
      "electiveId":"3bdda584-f7a2-4402-8863-4b5bd8273009",
      null,
"creditHours":2.00,
     
"isDev":truefalse,
 
    "orderInTerm":10,
    
 "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

Code Block

{
   "id":"0a90940a-3fc7-1f00-813f-ca10fee70002",
   "createdDate":1373484678888,
   "createdBy":{
      "duplicateOfTranscript":false,
"dev":false,
"isValidInTerm":false,
"hasPrerequisites":true,
"hasCorequisites":true,
"invalidReasons":" Course: AST215 is not currently offered in the selected term."},
{"id":"0a90940a-4086-1a71-8140-88c4568c0011",
"createdDate":1376684103308,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1376684103308,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"termCode":"SP2014",
"courseCode":"CST-410",
"formattedCourse":"CST410",
"courseTitle":"International Computing",
"courseDescription":" ",
"studentNotes":"",
"contactNotes":"notes",
"isImportant":false,
"isTranscript":false,
"electiveId":null,
"creditHours":2.00,
"isDev":false,
"orderInTerm":0,
"planToOffer":null,
"duplicateOfTranscript":false,
"dev":false,
"isValidInTerm":true,
"hasPrerequisites":true,
"hasCorequisites":true,
"invalidReasons":""}
...
]
}

Create Template (MAP)

Description

Creates a template

Method

POST /ssp/api/1/reference/map/template

Security

PERSON_MAP_WRITE

Returns

Code Block

{"id":"0a90940a-4086-1a71-8140-88c4568b000c",
"createdDate":1376684103307,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1376684103307,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"INACTIVE",
"name":"New template",
"ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "ownerName":"Amy Administrator",
   "contactTitle":"",
   "contactName":"",
   "contactPhone":"",
   "contactEmail":"",
"contactNotes":"",
"studentNotes":"",
"isFinancialAid":false,
"isImportant":false,
"isF1Visa":false,
"academicGoals":"",
"academicLink":"",
"careerLink":"",
"isValid":false,
"termNotes":[
{"id":"0a90940a-4086-1a71-8140-88c4568d0015",
"createdDate":1376684103309,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1376684103309,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"studentNotes":"notes",
"contactNotes":"",
"termCode":"SP2014",
"isImportant":false}],
"programCode":"EDU-AA",
"divisionCode":"",
"departmentCode":"",
"isPrivate":false,
"templateCourses":[
{"id":"0a90940a-4086-1a71-8140-88c4568c0014",
"createdDate":1376684103308,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1376684103308,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"termCode":"SU2014",
"courseCode":"AST-215",
"formattedCourse":"AST215",
"courseTitle":"Enterprise Astronomy",
"courseDescription":"  Course: AST215 is not currently offered in the selected term.",
"studentNotes":"",
"contactNotes":"",
"isImportant":false,
"isTranscript":false,
"electiveId":null,
"creditHours":2.00,
"isDev":false,
"orderInTerm":0,
"planToOffer":null,
"duplicateOfTranscript":false,
"dev":false,
"isValidInTerm":false,
"hasPrerequisites":true,
"hasCorequisites":true,
"invalidReasons":" Course: AST215 is not currently offered in the selected term."},
{"id":"0a90940a-4086-1a71-8140-88c4568c0011",
"createdDate":1376684103308,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1376684103308,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"objectStatus":"ACTIVE",
"termCode":"SP2014",
"courseCode":"CST-410",
"formattedCourse":"CST410",
"courseTitle":"International Computing",
"courseDescription":" ",
"studentNotes":"",
"contactNotes":"notes",
"isImportant":false,
"isTranscript":false,
"electiveId":null,
"creditHours":2.00,
"isDev":false,
"orderInTerm":0,
"planToOffer":null,
"duplicateOfTranscript":false,
"dev":false,
"isValidInTerm":true,
"hasPrerequisites":true,
"hasCorequisites":true,
"invalidReasons":""}
...
]
}

Update Template (MAP)

Description

Updates a template

Method

POST /ssp/api/1/reference/map/template/{id}

Security

PERSON_MAP_WRITE

Returns

Code Block

{"id":"0a90940a-4086-1a71-8140-88c4568b000c",
"createdDate":1376684103307,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "firstName":"Amy",
   "lastName":"Administrator"},
"modifiedDate":1376684103307,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"INACTIVE",
"name":"New template",
"ownerId":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "ownerName":"Amy Administrator",
   "contactTitle":"",
   "contactName":"",
   "contactPhone":"",
   "contactEmail":"",
"contactNotes":"",
"studentNotes":"",
"isFinancialAid":false,
"isImportant":false,
"isF1Visa":false,
"academicGoals":"",
"academicLink":"",
"careerLink":"",
"isValid":false,
"termNotes":[
{"id":"0a90940a-4086-1a71-8140-88c4568d0015",
"createdDate":1376684103309,
"createdBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
      "firstName":"Amy",
      "lastName":"Administrator"
   },

  "modifiedDate":13734847783721376684103309,
   "modifiedBy":{
      "id":"0a90940a-3efc-175f-813e-fc1ac581000b",

     "firstName":"Amy",
 
    "lastName":"Administrator"
   },
  
"objectStatus":"ACTIVE",
  "studentNotes":"notes",
"namecontactNotes":"Sample Plan",
  
"ownerIdtermCode":"0a90940a-3efc-175f-813e-fc1ac581000bSP2014",
   "ownerName"isImportant":false}],
"programCode":"Amy AdministratorEDU-AA",

  "contactTitledivisionCode":"Advisor",
  
"contactNamedepartmentCode":""John,
Smith"isPrivate":false,
   "contactPhone"templateCourses":[
{"id":"212-555-12120a90940a-4086-1a71-8140-88c4568c0014",
"createdDate":1376684103308,
"createdBy":
 {"contactEmailid":"advisor@college.edu0a90940a-3efc-175f-813e-fc1ac581000b",
   "contactNotesfirstName":"Advisor Plan Notes"Amy",
   "studentNoteslastName":"Administrator"Student Plan Notes",
   "isFinancialAid":true},
"modifiedDate":1376684103308,
"modifiedBy":
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
   "isImportantfirstName":true"Amy",
   "isF1VisalastName":true"Administrator"},
  "objectStatus":"ACTIVE",
"academicGoalstermCode":"Goals for AcademicsSU2014",
  
"academicLinkcourseCode":"http://www.college.edu/academic.htmlAST-215",
   "careerLinkformattedCourse":"http://www.college.edu/career.htmlAST215",
   "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":[
      {
         "courseTitle":"Enterprise Astronomy",
"courseDescription":"  Course: AST215 is not currently offered in the selected term.",
"studentNotes":"",
"contactNotes":"",
"isImportant":false,
"isTranscript":false,
"electiveId":null,
"creditHours":2.00,
"isDev":false,
"orderInTerm":0,
"planToOffer":null,
"duplicateOfTranscript":false,
"dev":false,
"isValidInTerm":false,
"hasPrerequisites":true,
"hasCorequisites":true,
"invalidReasons":" Course: AST215 is not currently offered in the selected term."},
{"id":"0a90940a-3fc74086-1f001a71-813f8140-ca128368001688c4568c0011",
        
"createdDate":13734847783441376684103308,
         "createdBy":{
            
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
        
   "firstName":"Amy",
     
      "lastName":"Administrator"},
     
"modifiedDate":1373484778344,
     1376684103308,
"modifiedBy":{
         
{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
  
      "firstName":"Amy",

        "lastName":"Administrator"},
     
"objectStatus":"ACTIVE",
      "termCode":"FA2013SP2014",
     
"courseCode":"IEE-105",
     CST-410",
"formattedCourse":"IEE105CST410",
     
"courseTitle":"AnalyticalInternational Industrial EngineeringComputing",
   
  "courseDescription":" ",
 
    "studentNotes":"Advisor Student Notes",
 
    "contactNotes":"Advisor Course Notesnotes",
    
 "isImportant":true,
     false,
"isTranscript":false,
     
"electiveId":"3bdda584-f7a2-4402-8863-4b5bd8273009",
      null,
"creditHours":2.00,
      "isDev":true,
      "orderInTerm":1,
      "planToOffer":null,
      "personId":"64a97729-7999-4b31-b70b-f0b705dff288",
      false,
"orderInTerm":0,
"planToOffer":null,
"duplicateOfTranscript":false,
      "dev":truefalse,

     "isValidInTerm":true,
     
"hasPrerequisites":true,
   
  "hasCorequisites":true,
     
"invalidReasons":""}
...
]
}

Print or

...

Validate Template (MAP)

Description

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

Method

GET POST /ssp/api/1/person/{person-uuid}/reference/map/plantemplate/print/{id}

GET POST /ssp/api/1/person/{person-uuid}reference/map/plantemplate/emailvalidate

Security

PERSON_MAP_READ

Returns

Print: HTML report based on the message_template for "Map Plan Full Printout"
EmailValidate: emailmarked withup HTMLJSON attachmentobject

Versions Compared

Old Version 1

New Version 2

Key

Get

Template (MAP)

Get Plan (MAP) Current

Create Template (MAP)

Update Template (MAP)

Print or

Validate Template (MAP)