Person Program Status API

Owned by Alexander Leader
Last updated: Nov 19, 2014 by Jason Elwood
3 min read

Description

Associates various program status records with a student.  Only one effective program status record can exist.  All others are expired.

Updated in v2.6.0

Get All Program Statuses

GET /ssp/api/1/person/{id}/programStatus

Security

PERSON_PROGRAM_STATUS_READ

Parameters

status : ALL, ACTIVE, INACTIVE
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",
      "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},
 {"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

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" : acf7d721-196f-4353-9508-fe86c61e3d80,
 "programStatusChangeReasonName" : "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

 

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

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" : acf7d721-196f-4353-9508-fe86c61e3d80,
 "programStatusChangeReasonName" : "Military Activated},}

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" : acf7d721-196f-4353-9508-fe86c61e3d80,
 "programStatusChangeReasonName" : "Military Activated}

 

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."}