...
Associates various program status records with a student. Only one effective program status record can exist. All others are expired.
| Info |
|---|
Updated in v2.6.0 |
Get All Program Statuses
GET /ssp/api/1/person/{id}/programStatus
...
| Code Block |
|---|
{"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",
"personId":"64a97729-7999-4b31-b70b-f0b705dff288",
"programStatusId" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"effectiveDate" : 1332216000000,
"expirationDate" : null,
"programStatusChangeReasonId" : nullacf7d721-196f-4353-9508-fe86c61e3d80},
"programStatusChangeReasonName" : "Military Activated},
{"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"},
"programStatusChangeReasonName" : "Military Activated},
...
]
} |
Get a Program Status
...
| Code Block |
|---|
{"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" : acf7d721-196f-4353-9508-fe86c61e3d80,
"programStatusChangeReasonName" : null} |
...
"Military Activated},} |
Get Current Program Status
This method will return the only program status that is not marked expired, if there is one.
GET /ssp/api/1/person/{id}/programStatus/current
Security
PERSON_PROGRAM_STATUS_READ
Returns
PersonProgramStatus
| Code Block |
|---|
{"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",
"personId":"64a97729-7999-4b31-b70b-f0b705dff288",
"programStatusId" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"effectiveDate" : 1332216000000,
"expirationDate" : null,
"programStatusChangeReasonId" : acf7d721-196f-4353-9508-fe86c61e3d80,
"programStatusChangeReasonName" : "Military Activated},} |
Create a Program Status
POST /ssp/api/1/person/{id}/programStatus
...
| Code Block |
|---|
{"programStatusId" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
"effectiveDate" : 1332216000000,
"expirationDate" : null,
"programStatusChangeReasonId" : acf7d721-196f-4353-9508-fe86c61e3d80,
"programStatusChangeReasonName" : null "Military Activated},} |
Returns
PersonProgramStatus
| Code Block |
|---|
{"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" : acf7d721-196f-4353-9508-fe86c61e3d80,
"programStatusChangeReasonName" : null"Military Activated} |
Delete a Program Status
...