Description
The programStatusChangeReasonRequired tells the consumer that when a student's program status is changed to this status then a ProgramStatusChangeReason must be specified.
Get All Program Statuses
GET /ssp/api/1/reference/programStatus
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
...
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "ce0d041dacf7d721-d3ac196f-42a14353-90859508-7f744240e07efe86c61e3c1d",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Active",
"description" : "Student is part of an active program."
"programStatusChangeReasonRequired" : false},
{"id" : "e34b0d14e8f6a45b-f6f079ce-4adb4687-85c6831c-694de9fc0685ca5f190dddc3",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Non-participating",
"description" : "The student has chosen to not participate in the advising services offered by the college.",
"programStatusChangeReasonRequired" : true},
...
]
} |
Get a
...
Program Status
GET /ssp/api/1/reference/programStatus/{id}
Security
SERVICE_REFERENCE_READ
Returns
| Code Block |
|---|
{"id" : "ce0d041dacf7d721-d3ac196f-42a14353-90859508-7f744240e07efe86c61e3c1d",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Active",
"description" : "Student is part of an active program."
"programStatusChangeReasonRequired" : false} |
Create a
...
Program Status
POST /ssp/api/1/reference/programStatus
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"name" : "Active",
"description" : "Student is part of an active program.",
"programStatusChangeReasonRequired" : false} |
Returns
ProgramStatus
| Code Block |
|---|
{"id" : "ce0d041dacf7d721-d3ac196f-42a14353-90859508-7f744240e07efe86c61e3c1d",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Active",
"description" : "Student is part of an active program.",
"programStatusChangeReasonRequired" : false} |
Save a Program Status
PUT /ssp/api/1/reference/programStatus/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "ce0d041dacf7d721-d3ac196f-42a14353-90859508-7f744240e07efe86c61e3c1d",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Active",
"description" : "Student is part of an active program.",
"programStatusChangeReasonRequired" : false} |
Returns
ProgramStatus
| Code Block |
|---|
{"id" : "ce0d041dacf7d721-d3ac196f-42a14353-90859508-7f744240e07efe86c61e3c1d",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Active",
"description" : "Student is part of an active program.",
"programStatusChangeReasonRequired" : false} |
Delete a Program Status
DELETE /ssp/api/1/reference/programStatus/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...