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 2 Next »

Get Template (MAP) Summary


Description

Paginated collection of all template summaries\, optionally filtered by status. See API notes for status parameter handling handling.

Method
GET /ssp/api/1/reference/map/template/summary


Security

PERSON_MAP_READ

Parameters

isPrivate: true,false

divisionCode:

programCode:

departmentCode:

status : ALL, ACTIVE, INACTIVE
 

Returns

{"success":"true",
"message":"",
"results":1,
"rows":[
{"id":"0a90940a-3f0c-1fe9-813f-0c6439ea00e5",
"createdDate":1370302462442,
"createdBy":
{"id":"30acbb3b-4f5e-490b-8652-e1f32a93718f",
   "firstName":"Richard",
   "lastName":"Thompson"},
"modifiedDate":1370302462442,
"modifiedBy":
{"id":"30acbb3b-4f5e-490b-8652-e1f32a93718f",
   "firstName":"Richard",
   "lastName":"Thompson"},
"objectStatus":"ACTIVE",
"name":"General Education Undergraduate Degree",
"ownerId":"30acbb3b-4f5e-490b-8652-e1f32a93718f",
   "ownerName":"Richard Thompson",
   "contactTitle":"Senior Advisor",
   "contactName":"R. Thompson",
   "contactPhone":"",
   "contactEmail":"",
"contactNotes":"",
"studentNotes":"",
"isFinancialAid":true,
"isImportant":true,
"isF1Visa":false,
"academicGoals":"Graduate bachelors degree.",
"academicLink":"Undergraduate Degree",
"careerLink":"B.A. Arts",
"isValid":true,
"termNotes":[],
"programCode":"",
"divisionCode":"DIV_HA",
"departmentCode":"DEP_AS",
"isPrivate":false,
"courses":null}]
}

Get Template (MAP)

Description

Template details

Method

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

Security

PERSON_MAP_READ

 

Returns

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

Create Template (MAP)


Description
Creates a template

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


Security

PERSON_MAP_WRITE

Returns

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

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

Print or Validate Template (MAP)

 

Description
Prints or validate the template details

Method
POST /ssp/api/1/reference/map/template/print/{id}
POST /ssp/api/1/reference/map/template/validate


Security

PERSON_MAP_READ

Returns

Print: HTML report based on the message_template for "Map Plan Full Printout"
Validate: marked up JSON object

 

  • No labels