Program Status Change Reason API

Owned by Alexander Leader
Last updated: Jul 11, 2012Version comment
3 min read

Get All Program Status Change Reasons

GET /ssp/api/1/reference/programStatusChangeReason

Security

SERVICE_REFERENCE_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" : "23a93baa-3eb6-4a59-a540-614637322c53",
      "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" : "Financially Unable to Pay for Tuition",
      "description" : "Financially Unable to Pay for Tuition"},
     {"id" : "d0af4f16-3b42-4369-b684-28f003cf5918",
      "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" : "Services Not Needed",
      "description" : "Services Not Needed"},
     ...
    ]
}

 

Get a Program Status Change Reason

GET /ssp/api/1/reference/programStatusChangeReason/{id}

Security

SERVICE_REFERENCE_READ

Returns

{"id" : "23a93baa-3eb6-4a59-a540-614637322c53",
 "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" : "Financially Unable to Pay for Tuition",
 "description" : "Financially Unable to Pay for Tuition"}

 

Create a Program Status Change Reason

POST /ssp/api/1/reference/programStatusChangeReason

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"name" : "Financially Unable to Pay for Tuition",
 "description" : "Financially Unable to Pay for Tuition"}

Returns

ProgramStatusChangeReason

{"id" : "23a93baa-3eb6-4a59-a540-614637322c53",
 "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" : "Financially Unable to Pay for Tuition",
 "description" : "Financially Unable to Pay for Tuition"}

 

Save a Program Status Change Reason

PUT /ssp/api/1/reference/programStatusChangeReason/{id}

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"id" : "23a93baa-3eb6-4a59-a540-614637322c53",
 "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" : "Financially Unable to Pay for Tuition",
 "description" : "Financially Unable to Pay for Tuition"}

Returns

ProgramStatusChangeReason

{"id" : "23a93baa-3eb6-4a59-a540-614637322c53",
 "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" : "Financially Unable to Pay for Tuition",
 "description" : "Financially Unable to Pay for Tuition"}

 

Delete a Program Status Change Reason

DELETE /ssp/api/1/reference/programStatusChangeReason/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}