Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Description

The Disability Accommodation Services API returns a wrapper transfer object that contains both the student specific data but also lookup data for the front-end view.  This was done to limit the number of calls to the back-end services and to increase performance of the front-end view.

Get

...

Accommodation Services Form

GET /ssp/api/1/tool/disabilityIntakeaccommodation/{id}

Security

ROLE_DISABILITY_INTAKEACCOMMODATION_READ

Returns

DisabilityServicesFormAccommodationForm

Code Block
{
    "person": {
        "id": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
        "createdDate": 1332216000000,
        "createdBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "modifiedDate": 1357777015143,
        "modifiedBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "objectStatus": "ACTIVE",
        "firstName": "Sally",
        "middleName": null,
        "lastName": "Student",
        "birthDate": null,
        "primaryEmailAddress": "sally.student@university.edu",
        "secondaryEmailAddress": null,
        "username": "sally.student",
        "homePhone": "123-456-7890",
        "workPhone": null,
        "cellPhone": null,
        "nonLocalAddress": null,
        "addressLine1": "444 West Third Street",
        "addressLine2": null,
        "city": "Dayton",
        "state": "OH",
        "zipCode": "45402     ",
        "alternateAddressInUse": null,
        "alternateAddressLine1": null,
        "alternateAddressLine2": null,
        "alternateAddressCity": null,
        "alternateAddressState": null,
        "alternateAddressZipCode": null,
        "alternateAddressCountry": null,
        "photoUrl": null,
        "schoolId": null,
        "enabled": false,
        "studentIntakeCompleteDate": null,
        "studentType": {
            "id": "b2d058eb-5056-a51a-80a7-8a20c30d1e91",
            "name": "DIS",
            "objectStatus": "ACTIVE"
        },
        "coach": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "Amy",
            "lastName": "Advisor",
            "primaryEmailAddress": "amy.advisor@university.edu",
            "workPhone": "123-456-7654",
            "officeLocation": "123 Benton Hall Room A",
            "departmentName": "Engineering & Applied Science"
        },
        "strengths": "Good listener",
        "abilityToBenefit": true,
        "anticipatedStartTerm": "Fall",
        "anticipatedStartYear": "2012",
        "actualStartTerm": null,
        "actualStartYear": null,
        "studentIntakeRequestDate": 1331269200000,
        "specialServiceGroups": [
            {
                "id": "40b6b8aa-bca1-11e1-9344-037cb4088c72",
                "name": "Distance Learning",
                "objectStatus": "ACTIVE"
            }
        ],
        "referralSources": [
            {
                "id": "c54aa656-bd7a-11e1-9ced-5b723f71da43",
                "name": "Disability Services",
                "objectStatus": "ACTIVE"
            }
        ],
        "serviceReasons": null,
        "confidentialityLevels": null,
        "permissions": null,
        "currentProgramStatusName": "Active",
        "registeredForCurrentTerm": false
    },
    "personDisability": {
        "id": "0a080048-3c21-1af7-813c-21d1115b0001",
        "createdDate": 1357777015130,
        "createdBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "modifiedDate": 1357777015131,
        "modifiedBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "objectStatus": "ACTIVE",
        "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
        "disabilityStatusId": "24d12b6f-1d58-4f13-ac5e-c09cd249ba43",
        "releaseSigned": false,
        "recordsRequested": false,
        "referForScreening": false,
        "eligibleLetterSent": false,
        "ineligibleLetterSent": false,
        "noDocumentation": false,
        "inadequateDocumentation": false,
        "noDisability": false,
        "noSpecialEd": false,
        "onMedication": false,
        "intakeCounselor": "Cathy James",
        "referredBy": "Mildred Jones",
        "contactName": "",
        "recordsRequestedFrom": "",
        "documentsRequestedFrom": "",
        "rightsAndDuties": "false",
        "tempEligibilityDescription": "Waiting on documentation",
        "medicationList": "",
        "functionalLimitations": "",
        "eligibleLetterDate": null,
        "ineligibleLetterDate": null
    },
    "personDisabilityAgencies": [
        {
            "id": "0a080048-3c21-1af7-813c-21d111600004",
            "createdDate": 1357777015136,
            "createdBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "modifiedDate": 1357777015136,
            "modifiedBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "objectStatus": "ACTIVE",
            "disabilityAgencyId": "02aa9557-c8f1-4716-bbae-2b3401e386f6",
            "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
            "description": null
        },
        {
            "id": "0a080048-3c21-1af7-813c-21d1115f0003",
            "createdDate": 1357777015135,
            "createdBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "modifiedDate": 1357777015135,
            "modifiedBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "objectStatus": "ACTIVE",
            "disabilityAgencyId": "7f92b5bb-8e9c-44c7-88fd-2ffdce68ef98",
            "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
            "description": null
        }
    ...
    ],
    "personDisabilityAccommodations": [
   
    {
     
      "id": "0a0800480a0f0f59-3c213ca7-1af71beb-813c-21d1115f0002a7bbcbe80004",
     
      "createdDate": 13577770151351360023768040,
            "createdBy": {

               "id": "91f46e39da572870-cea85699-422b11e2-b215be1e-00f6bcf5d280406c8f22c3ce",
  
             "firstName": "JohnRuss",
                "lastName": "DoeLittle"
  
         },
   
        "modifiedDate": 13577770151351360023768040,
            "modifiedBy": {
       
        "id": "91f46e39da572870-cea85699-422b11e2-b215be1e-00f6bcf5d280406c8f22c3ce",
     
          "firstName": "JohnRuss",
  
             "lastName": "Doe"
     Little"
      },

           "objectStatus": "ACTIVE",
 
          "disabilityAccommodationId": "3c3a0e9d1f18e705-ed9d187a-47ad447d-9a5c8f03-c4afe4edbe698814fc854fc6",
     
      "personId": "1010e4a00a0f0f59-10013ca7-01101e9d-1011813c-4ffc02fe81ffa79f647a0019",
            "description": null
   
    }
    ...
    ],
    "personDisabilityTypes": [
        {
            "id": "0a080048-3c21-1af7-813c-21d111600005",
            "createdDate": 1357777015136,
            "createdBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "modifiedDate": 1357777015136,
            "modifiedBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "objectStatus": "ACTIVE",
            "disabilityTypeId": "c9afc03f-b7a2-4d8d-9603-09d313783a04",
            "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
            "description": "Site impaired. Needs assistance through screen reader."
        }
    ...
    ],
    "referenceData": {
        "disabilityStatuses": [
            {
                "id": "e0208429-aeb2-4854-ab7c-3c9281c96002",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "Eligible",
                "description": "Eligible"
            }
        ...
        ],
        "disabilityAgencies": [
            {
                "id": "6b209a6d-70b9-416c-95a5-17cab4594f85",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "BVR",
                "description": "BVR"
            }
        ...
        ],
        "disabilityAccommodations": [
            {
                "id": "3761d6a4-6f71-4c88-a1d7-f9bea7079346",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "To be determined",
                "description": "",
                "descriptionFieldLabel": null,
                "useDescription": null,
                "descriptionFieldType": null
            },
            {
                "id": "f4620bbb-35b5-4fac-9746-60e81abeb5b9",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "Extended time on exams/quizzes",
                "description": "",
                "descriptionFieldLabel": "Specify Time",
                "useDescription": true,
                "descriptionFieldType": "short"
            },
            {
                "id": "85138559-4d40-420d-bd78-119276a7b42c",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "Distraction-free testing environment -Testing Center",
                "description": "",
                "descriptionFieldLabel": null,
                "useDescription": null,
                "descriptionFieldType": null
            }
        ...
        ],
        "disabilityTypes": [
            {
                "id": "c049aec0-9c5c-46a6-8586-604688e9ac69",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "DH",
                "description": "1"
            },
            {
                "id": "faf8ae05-a865-4696-8585-e7a7b65d3600",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "HDH",
                "description": "2"
            },
            {
                "id": "9e8377a3-ded3-4338-9780-8161748601fc",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "DF",
                "description": "3"
            },
            {
                "id": "35ed9080-e88b-473a-83a4-565c5c56a756",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "SP",
                "description": "4"
            },
            {
                "id": "b7c3a3c0-de28-4d46-a42b-3de5f294a07f",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "VIS",
                "description": "5"
            },
            {
                "id": "997df364-627b-4fae-a58a-646e20d7ab6f",
                "createdDate": 1349064000000,
                "createdBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "modifiedDate": 1349064000000,
                "modifiedBy": {
                    "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                    "firstName": "John",
                    "lastName": "Doe"
                },
                "objectStatus": "ACTIVE",
                "name": "EMO",
                "description": "6"
            }
        ...
        ]
    }
}

 

Save the

...

Accommodation Services Form

PUT /ssp/api/1/tool/disabilityIntakeaccommodation/{id}

Security

ROLE_DISABILITY_INTAKEACCOMMODATION_WRITE

Sample Post

Code Block
{
    "person": {
        "id": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
        "createdDate": 1332216000000,
        "createdBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "modifiedDate": 1357777015143,
        "modifiedBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "objectStatus": "ACTIVE",
        "firstName": "Sally",
        "middleName": null,
        "lastName": "Student",
        "birthDate": null,
        "primaryEmailAddress": "sally.student@university.edu",
        "secondaryEmailAddress": null,
        "username": "sally.student",
        "homePhone": "123-456-7890",
        "workPhone": null,
        "cellPhone": null,
        "nonLocalAddress": null,
        "addressLine1": "444 West Third Street",
        "addressLine2": null,
        "city": "Dayton",
        "state": "OH",
        "zipCode": "45402     ",
        "alternateAddressInUse": null,
        "alternateAddressLine1": null,
        "alternateAddressLine2": null,
        "alternateAddressCity": null,
        "alternateAddressState": null,
        "alternateAddressZipCode": null,
        "alternateAddressCountry": null,
        "photoUrl": null,
        "schoolId": null,
        "enabled": false,
        "studentIntakeCompleteDate": null,
        "studentType": {
            "id": "b2d058eb-5056-a51a-80a7-8a20c30d1e91",
            "name": "DIS",
            "objectStatus": "ACTIVE"
        },
        "coach": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "Amy",
            "lastName": "Advisor",
            "primaryEmailAddress": "amy.advisor@university.edu",
            "workPhone": "123-456-7654",
            "officeLocation": "123 Benton Hall Room A",
            "departmentName": "Engineering & Applied Science"
        },
        "strengths": "Good listener",
        "abilityToBenefit": true,
        "anticipatedStartTerm": "Fall",
        "anticipatedStartYear": "2012",
        "actualStartTerm": null,
        "actualStartYear": null,
        "studentIntakeRequestDate": 1331269200000,
        "specialServiceGroups": [
            {
                "id": "40b6b8aa-bca1-11e1-9344-037cb4088c72",
                "name": "Distance Learning",
                "objectStatus": "ACTIVE"
            }
        ],
        "referralSources": [
            {
                "id": "c54aa656-bd7a-11e1-9ced-5b723f71da43",
                "name": "Disability Services",
                "objectStatus": "ACTIVE"
            }
        ],
        "serviceReasons": null,
        "confidentialityLevels": null,
        "permissions": null,
        "currentProgramStatusName": "Active",
        "registeredForCurrentTerm": false
    },
    "personDisability": {
        "id": "0a080048-3c21-1af7-813c-21d1115b0001",
        "createdDate": 1357777015130,
        "createdBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "modifiedDate": 1357777015131,
        "modifiedBy": {
            "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
            "firstName": "John",
            "lastName": "Doe"
        },
        "objectStatus": "ACTIVE",
        "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
        "disabilityStatusId": "24d12b6f-1d58-4f13-ac5e-c09cd249ba43",
        "releaseSigned": false,
        "recordsRequested": false,
        "referForScreening": false,
        "eligibleLetterSent": false,
        "ineligibleLetterSent": false,
        "noDocumentation": false,
        "inadequateDocumentation": false,
        "noDisability": false,
        "noSpecialEd": false,
        "onMedication": false,
        "intakeCounselor": "Cathy James",
        "referredBy": "Mildred Jones",
        "contactName": "",
        "recordsRequestedFrom": "",
        "documentsRequestedFrom": "",
        "rightsAndDuties": "false",
        "tempEligibilityDescription": "Waiting on documentation",
        "medicationList": "",
        "functionalLimitations": "",
        "eligibleLetterDate": null,
        "ineligibleLetterDate": null
    },
    "personDisabilityAgencies": [
        {
            "id": "0a080048-3c21-1af7-813c-21d111600004",
            "createdDate": 1357777015136,
            "createdBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "modifiedDate": 1357777015136,
            "modifiedBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "objectStatus": "ACTIVE",
            "disabilityAgencyId": "02aa9557-c8f1-4716-bbae-2b3401e386f6",
            "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
            "description": null
        },
        {
            "id": "0a080048-3c21-1af7-813c-21d1115f0003",
            "createdDate": 1357777015135,
            "createdBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "modifiedDate": 1357777015135,
            "modifiedBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "objectStatus": "ACTIVE",
            "disabilityAgencyId": "7f92b5bb-8e9c-44c7-88fd-2ffdce68ef98",
            "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
            "description": null
        }
    ...
    ],
    "personDisabilityAccommodations": [
        {
            "id": "0a080048-3c21-1af7-813c-21d1115f0002",
            "createdDate": 1357777015135,
            "createdBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "modifiedDate": 1357777015135,
            "modifiedBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "objectStatus": "ACTIVE",
            "disabilityAccommodationId": "3c3a0e9d-ed9d-47ad-9a5c-c4afe4edbe69",
            "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
            "description": null
        }
    ...
    ],
    "personDisabilityTypes": [
        {
            "id": "0a080048-3c21-1af7-813c-21d111600005",
            "createdDate": 1357777015136,
            "createdBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "modifiedDate": 1357777015136,
            "modifiedBy": {
                "id": "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName": "John",
                "lastName": "Doe"
            },
            "objectStatus": "ACTIVE",
            "disabilityTypeId": "c9afc03f-b7a2-4d8d-9603-09d313783a04",
            "personId": "1010e4a0-1001-0110-1011-4ffc02fe81ff",
            "description": "Site impaired. Needs assistance through screen reader."
        }
    ...
    ]
}

...