Disability Accommodation API

Owned by Jason Elwood
Last updated: Feb 02, 2013Version comment
2 min read

Get All Disability Accommodations

GET /ssp/api/1/reference/disabilityAccommodation

Security

SERVICE_REFERENCE_READ

Returns

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Enlarged Print Materials",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Enlarged Print Materials",
 "objectStatus" : "ACTIVE",
 "useDescription" : "true",
 "descriptionFieldLabel" : "Specify Font Size",
 "descriptionFieldType" : "short"}

 

Get Disability Accommodation by parameter

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

Security

SERVICE_REFERENCE_READ

Returns

Disability Accommodation

{ "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
  "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Enlarged Print Materials",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Enlarged Print Materials",
 "objectStatus" : "ACTIVE",
 "useDescription" : "true",
 "descriptionFieldLabel" : "Specify Font Size",
 "descriptionFieldType" : "short"}

 

Create a Disability Accommodation

POST /ssp/api/1/reference/disabilityAccommodation

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"description" : "Enlarged Print Materials Required",
 "name" : "Enlarged Print Materials"}

Returns

Disability Accommodation

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Enlarged Print Materials",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Enlarged Print Materials",
 "objectStatus" : "ACTIVE",
 "useDescription" : "true",
 "descriptionFieldLabel" : "Specify Font Size",
 "descriptionFieldType" : "short"}

 

Save a Disability Accommodations

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Enlarged Print Materials",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Enlarged Print Materials",
 "objectStatus" : "ACTIVE",
 "useDescription" : "true",
 "descriptionFieldLabel" : "Specify Font Size",
 "descriptionFieldType" : "short"}

Returns

Disability Accommodations

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Enlarged Print Materials",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Enlarged Print Materials",
 "objectStatus" : "ACTIVE",
 "useDescription" : "true",
 "descriptionFieldLabel" : "Specify Font Size",
 "descriptionFieldType" : "short"}

 

Delete a Disability Accommodation

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

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

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