Description
Associates various program status records with a student. Only one effective program status record can exist. All others are expired.
Get All Program Statuses
GET /ssp/api/1/person/{id}/programStatus
Security
PERSON_PROGRAM_STATUS_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)
Returns
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"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",
"programStatusId" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"effectiveDate" : 1332216000000,
"expirationDate" : null,
"programStatusChangeReasonId" : null},
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"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",
"programStatusId" : "e8f6a45b-79ce-4687-831c-ca5f190dddc3",
"effectiveDate" : 1332216000000,
"expirationDate" : 1332216000000,
"programStatusChangeReasonId" : "23a93baa-3eb6-4a59-a540-614637322c53"},
...
]
}
Get a Program Status
GET /ssp/api/1/person/{id}/programStatus/{id}
Security
PERSON_PROGRAM_STATUS_READ
Returns
PersonProgramStatus
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"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",
"programStatusId" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"effectiveDate" : 1332216000000,
"expirationDate" : null,
"programStatusChangeReasonId" : null}
Create a Program Status
POST /ssp/api/1/person/{id}/programStatus
Security
PERSON_PROGRAM_STATUS_WRITE
Note
Any existing person program status record that is not expired will be expired (expirationDate = current datetime) when a new person program status is created.
Sample Post
{"programStatusId" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"effectiveDate" : 1332216000000,
"expirationDate" : null,
"programStatusChangeReasonId" : null}
Returns
PersonProgramStatus
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"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",
"programStatusId" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"effectiveDate" : 1332216000000,
"expirationDate" : null,
"programStatusChangeReasonId" : null}
Delete a Program Status
DELETE /ssp/api/1/person/{id}/programStatus/{id}
Security
PERSON_PROGRAM_STATUS_DELETE
Note
Set expirationDate equivalent to the current date.
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}