create
Adds a new hearing to our system.
method | POST |
endpoint | /api/v2/hearing |
return | Hearing Model |
Parameters
Key | Type | Requirement | Description |
---|---|---|---|
client_first_name | string | required | First name of the claimant. |
client_last_name | string | required | Last name of the claimant |
client_ssn | int | optional | SSN of the claimant. Nine digits only. |
hearing_date | string | required | Date of the hearing. MM/DD/YYYY. |
hearing_time | string | required | Time of the hearing local to hearing location and hearing date. H:MM AM/PM in 5 minute increments from 7:00 AM to 5:00 PM. 7:00 AM, 7:05 AM, 12:30 PM, 12:35 PM, etc. |
location_id | int | required | Hearing location id. |
user_advocate_attending | int | optional | The attending attorney's ID for this hearing. |
suggested_attendee | string | optional | The suggested attendee to attend this hearing. |
judge_id | int | required | The ALJ's ID for the hearing. |
require_ve | boolean | optional | Whether or not a vocational expert is required for this hearing. |
require_me | boolean | optional | Whether or not a medical expert is required for this hearing. |
require_vtc | boolean | optional | Whether or not this hearing is over video teleconference. |
hearing_outcome | int | optional | The final outcome of the hearing. 1 = Unfavorable Hearing Outcome, 2 = Partially Favorable Hearing Outcome, 3 = Favorable Hearing Outcome |
note | string | optional | Add a new note to this hearing. |
initials | string | conditional | Initials if a note is being added with this hearing. |
cancelled_at | string | optional | If the hearing was cancelled this field contains the date and time it was cancelled at. YYYY-MM-DD HH:MM:SS. You may request that the hearing be cancelled by sending this field when the hearing is not already cancelled. |
candidates | association | optional | An array containing prefered attorneys. Each entry should include the keys "user_id" (same as attorney) and "score" ranging from 0-100 representing a preference order. |
external_id | string | optional | If you have an external indentifier you'd like to keep track of for this hearing you can use this field. |
skip_approval | bool | optional | Development environment only, has no affect on live. Most edits to hearings require an approval process that delays any changes from being applied. Setting this field to 1 will make any changes get automatically approved. |
update
Update an existing hearing in our system.
method | PUT |
endpoint | /api/v2/hearing/{id} |
return | Hearing Model |
Parameters
Key | Type | Requirement | Description |
---|---|---|---|
client_first_name | string | required | First name of the claimant. |
client_last_name | string | required | Last name of the claimant |
client_ssn | int | optional | SSN of the claimant. Nine digits only. |
hearing_date | string | required | Date of the hearing. MM/DD/YYYY. |
hearing_time | string | required | Time of the hearing local to hearing location and hearing date. H:MM AM/PM in 5 minute increments from 7:00 AM to 5:00 PM. 7:00 AM, 7:05 AM, 12:30 PM, 12:35 PM, etc. |
location_id | int | required | Hearing location id. |
user_advocate_attending | int | optional | The attending attorney's ID for this hearing. |
suggested_attendee | string | optional | The suggested attendee to attend this hearing. |
judge_id | int | required | The ALJ's ID for the hearing. |
require_ve | boolean | optional | Whether or not a vocational expert is required for this hearing. |
require_me | boolean | optional | Whether or not a medical expert is required for this hearing. |
require_vtc | boolean | optional | Whether or not this hearing is over video teleconference. |
hearing_outcome | int | optional | The final outcome of the hearing. 1 = Unfavorable Hearing Outcome, 2 = Partially Favorable Hearing Outcome, 3 = Favorable Hearing Outcome |
note | string | optional | Add a new note to this hearing. |
initials | string | conditional | Initials if a note is being added with this hearing. |
cancelled_at | string | optional | If the hearing was cancelled this field contains the date and time it was cancelled at. YYYY-MM-DD HH:MM:SS. You may request that the hearing be cancelled by sending this field when the hearing is not already cancelled. |
candidates | association | optional | An array containing prefered attorneys. Each entry should include the keys "user_id" (same as attorney) and "score" ranging from 0-100 representing a preference order. |
external_id | string | optional | If you have an external indentifier you'd like to keep track of for this hearing you can use this field. |
skip_approval | bool | optional | Development environment only, has no affect on live. Most edits to hearings require an approval process that delays any changes from being applied. Setting this field to 1 will make any changes get automatically approved. |
view
Show details related to a hearing in our system.
method | GET |
endpoint | /api/v2/hearing/{id} |
return | Hearing Model |
list
Returns an array containing available hearings in our system.
method | GET |
endpoint | /api/v2/hearing |
return | Hearing Model Collection |
assign
Make a request to assign an attorney to a hearing. You can get a current list of your available attorneys by using the attorney list endpoint. If there is already an assigned attorney then the current assigned attorney will be removed and the new one provided will be assigned.
method | POST |
endpoint | /api/v2/hearing/assign |
return | Basic Response |
Parameters
Key | Type | Requirement | Description |
---|---|---|---|
hearing_id | int | required | Assure's ID for the hearing you would like to assign an attorney to. |
attorney_id | int | required | Assure's ID for the attorney you would like to assign. |
skip_approval | bool | optional | Development environment only, has no affect on live. Most edits to hearings require an approval process that delays any changes from being applied. Setting this field to 1 will make any changes get automatically approved. |
unassign
Make a request to unassign an attorney from a hearing.
method | POST |
endpoint | /api/v2/hearing/unassign |
return | Basic Response |
Parameters
Key | Type | Requirement | Description |
---|---|---|---|
hearing_id | int | required | Assure's ID for the hearing you would like to remove an attorney from. |