API Documentation v3

  1. API
  2. v3

Introduction

Welcome to the Assure API. Version 3 of the API focuses on the addition of case and case file options.


Timestamps returned by requests are in the 24 hour format and use the current Central timezone (UTC-6 during CST and UTC-5 during CDT).


Authorization

Our API makes use of OAuth 2 using client credentials. If you are interested in using this service, please contact us at api@myassureservices.com. We will need your account login email and a list of endpoints you would like to use.

Example Request

We recommend you use an established OAuth library to authenticate with our API. How ever it is quite simple even with out a library.

1. Make a POST request to https://app.myassureservices.com/oauth/access_token containing the following variables:

  • grant_type = client_credentials
  • client_id = <your client id>
  • client_secret = <your client secret>
2. You will get a response back containing information. If the request failed the reason why will be returned to you. If your credentials are correct you will get a response back containing the following:
  • access_token = <generated access token>
  • token_type = Bearer
  • expires_in = 3600
3. Now that you have an access_token you can make requests to the API. If you wanted to view details for a hearing you send a GET request to the /api/v3/hearing/{hearing id} API endpoint with the following header information:
  • Authorization: Bearer <generated access token>
4. Keep in mind that your access token is only valid for the number of seconds contained in the expires_in variable that is returned to you in your authentication request. Keeping track of when your access_token expires is where a library can come in handy. You can use the same access token for all request until it expires.

Parameter Type Information

boolean: A boolean value will be a 1 or 0. 1 = true, 0 = false. When sending us data you should use a 1 or a 0 to represent boolean values.

association: An association can be an array containing arrays with a data model fields or a single array containing all data model fields depending on the endpoint. An association may also be an empty value when no association is present.

empty values: A value of "null", "{}" or an empty string ("") should all be considered as no value present.


Endpoints

Attorneys

view

Show details related to an attorney in our system.

method GET
endpoint /api/v3/attorney/{id}
return Attorney Model

list

Returns an array containing available attorneys in our system.

method GET
endpoint /api/v3/attorney
return Attorney Model Collection

Briefs

view

Show details related to a brief request in our system.

method GET
endpoint /api/v3/brief/{id}
return Brief Model

list

Returns an array containing available brief requests in our system.

method GET
endpoint /api/v3/brief
return Brief Model Collection

CaseFiles

view

Show details for case files connected to a case. Returns a collection containing both the Exhibited and All version of case files if present.

method GET
endpoint /api/v3/case-file/{case_id}
return A collection of Case File Models or a single Case File Model when a type is provided.

Parameters

Key Type Requirement Description Values
type int optional The type of case file to return. Toggle Possible Values

download-check

Send a request to check the ERE and download available case files. A case may only have one of each type of case file attached to it. If a case file is already attached you will get an error back, please use the update-check endpoint to check for updates. This API endpoint may have longer response times than usual. Sometimes one or more status reports will have to be downloaded to verify the claimant can be found on the ERE in order to automatically select the correct credentials to use. If you encounter request timeouts please increase your request timeout to 120 or more seconds for these API requests to allow for multiple status reports to be downloaded from the ERE when required.

method POST
endpoint /api/v3/case-file/download-check
return Case File Model

Parameters

Key Type Requirement Description Values
hearing_id int conditional Assure's ID for the hearing the case file will be attached to. Required when case_id is empty.
case_id int conditional Assure's ID for the case the case file will be attached to. Required when hearing_id is empty.
type int required The type of the case file. Toggle Possible Values

update-check

Send a request to trigger an update to check the ERE for any changes for a case file.

method POST
endpoint /api/v3/case-file/update-check
return Case File Model

Parameters

Key Type Requirement Description Values
hearing_id int conditional Assure's ID for the hearing the case file is attached to. Required when case_id is empty.
case_id int conditional Assure's ID for the case the case file is attached to. Required when hearing_id is empty.
type int required The type of the case file. Toggle Possible Values

download

Send a request to download a case file. A case file is available for download when the file_id field is set, you should use the view endpoint to check if a case file is available for download.

method GET
endpoint /api/v3/case-file/download
return File, JSON

Parameters

Key Type Requirement Description Values
hearing_id int conditional Assure's ID for the hearing the case file is attached to. Required when case_id is empty.
case_id int conditional Assure's ID for the case the case file is attached to. Required when hearing_id is empty.
method string conditional The method to use when returning the case file. Toggle Possible Values
type int required The type of the case file. Toggle Possible Values

Returns

When the method of download is set to base64 the data field of the response will contain the below fields.

Name Desc
name The name of the file.
size The size of the file in bytes.
file The base64 encoded file data.

Cases

create

Create a new case that is in the State Agency status. A credential ID is required to be able to pull case files.

method POST
endpoint /api/v3/case
return Case Model

Parameters

Key Type Requirement Description Values
first_name string required First name of the claimant.
middle_name string optional Middle name or initial of the claimant.
last_name string required Last name of the claimant
client_ssn string required SSN of the claimant. Only the first 5 digits provided will be used when updating, any formatting will be stripped. The last four of the SSN that originate from the status report can not be changed on normal imported cases. When creating or updating State Agency cases the full SSN will be updated.
claim_type int optional The type of claim for this case. Toggle Possible Values
pull_case_file boolean required Whether or not you want try and pull an All case file on the creation of this case. You may not have access to this State Agency case yet on the ERE and have an increased risk of getting an SSN error.
credential_id int conditional Set the ID of the credentials this State Agency case belongs to. Required when pull_case_file is set to 1.

update

Update an existing case in our system.

method POST
endpoint /api/v3/case/{id}
return Case Model

Parameters

Key Type Requirement Description Values
client_ssn string required SSN of the claimant. Only the first 5 digits provided will be used when updating, any formatting will be stripped. The last four of the SSN that originate from the status report can not be changed on normal imported cases. When creating or updating State Agency cases the full SSN will be updated.

list

Returns an array containing available cases.

method GET
endpoint /api/v3/case
return A collection of Case Models

Filters

Filter Format Example Description Values
page int /api/v3/case?page=2 Go to a different page of the results.
paginate int /api/v3/case?paginate=50 Set the number of results returned per page. Default 50. 1000 per page limit.
exhibited_case_file_updates MM/DD/YYYY-MM/DD/YYYY /api/v3/case?exhibited_case_file_updates=01/01/2019-12/31/2019 Filter cases by the exhibited case file's update_completed_at date.
date_from MM/DD/YYYY /api/v3/case?date_from=01/01/2019 Filter on a date_type greater than or equal to this date.
date_through MM/DD/YYYY /api/v3/case?date_through=01/30/2019 Filter on a date_type less than or equal to this date.
date_type string /api/v3/case?date_type=hearing_date&date_from=01/01/2019 Set a field to use for the date_from and date_through filter. Toggle Possible Values
visibility string /api/v3/case?visibility=active,needs_ssn_update Set a visibility filter. You may use multiple options at a time, separate each value with a comma. Toggle Possible Values
case_status string /api/v3/case?case_status=1,2 Set one or more case statuses to filter on. You may use multiple options at a time, separate each value with a comma. Toggle Possible Values
hearing_id string /api/v3/case?hearing_id=1 Filter on a hearing ID. Can be used to find cases that are connected to specified hearings. Separate multiple values with a comma.

view

Show details for a case.

method GET
endpoint /api/v3/case/{id}
return Case Model

DocPreHearingChecklists

view

Show details related to a pre-hearing checklist in our system.

method GET
endpoint /api/v3/doc-pre-hearing-checklist/{id}
return DocPreHearingChecklist Model

DocTypes

view

Show details related to a doc type in our system.

method GET
endpoint /api/v3/doc-type/{id}
return Doc Type Model

list

Returns an array containing available document types in our system.

method GET
endpoint /api/v3/doc-type
return Doc Type Model Collection

EreFiles

create

Uploads a file to our system, attaches it to a case and puts it in the queue to be uploaded to the ERE. Sending a file with this API endpoint does not guarantee the file will be uploaded to the ERE. You must subscribe to our webhooks or check the file with the view endpoint to see the current status of the file. Most files will be uploaded within a few minutes. When a ERE file has a tracking_number and a status of 4 it can be considered successfully uploaded to the ERE.

File Restrictions:

  • 200MB file size limit.
  • Only wpd, doc, docx, jpg, bmp, txt, rtf, xls, xlsx, pdf, tiff, and tif file formats are accepted.

method POST
endpoint /api/v3/ere-file
return ERE File Model

Parameters

Key Type Requirement Description Values
case_id int required The ID of the case this file is attached to.
file file conditional File to be uploaded. Required if file_base64 is empty. You may submit a multipart/form-data request with all the required fields and a file to avoid the slower uploads and overhead of base64 encoded file uploads.
file_base64 string conditional A base64 encoded file with additional data to be uploaded. Please review the table below for the list of acceptable fields and format. Required if file is empty. Toggle Possible Values
document_type string required The ERE document type ID. Toggle Possible Values
treatment_source string conditional The treatment source of the document. Required when document_type is 0001 or 3157. 57 character limit, only accepts a-Z, 0-9 and spaces.
from_date string conditional The from date of the document. Required when document_type is 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
to_date string conditional The from date of the document. Required when document_type is 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
document_date string conditional The date of the document. Required when document_type is anything other than 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
notes string optional Notes about the document. 40 character limit, only accepts a-Z, 0-9 and spaces.

view

Show details for an ERE File.

method GET
endpoint /api/v3/ere-file/{id}
return ERE File Model

Files

create

Uploads a file to our system and attaches it to a hearing. 200MB file size limit. Only .pdf, .doc, .docx, .png, .tiff, and .txt files are accepted.

method POST
endpoint /api/v3/file
return File Model

Parameters

Key Type Requirement Description Values
doc_type_id int required The doc type id for this file.
file file required File to be uploaded.
hearing_id int required The ID of the hearing this file will be attached to.

HearingNotes

create

Create a new note attached to a hearing. This endpoint is intended for general notes on a hearing, if you are making a hearing note containing a request to make changes to a hearing please use the hearing update endpoint with the "note" and "initials" fields to add your note to a hearing in order for hearing schedulers to review your request. If you add a note requesting changes to a hearing with this endpoint it will not notify hearing schedulers and your request may not be seen.

method POST
endpoint /api/v3/hearing-note
return HearingNote Model

Parameters

Key Type Requirement Description Values
hearing_id int required Assure's ID for the hearing you would like to attach the note to.
content string required The contents of the note.
initials string required Initials to use for this note. Five character limit.

list

Returns an array of HearingNote models attached to the provided hearing ID. Hearing notes are sorted by created at in descending order.

method GET
endpoint /api/v3/hearing-note
return HearingNote Model Collection

Parameters

Key Type Requirement Description Values
hearing_id int required Assure's ID for the hearing you want to list notes for.

Filters

Filter Format Example Description Values
page int /api/v3/hearing-note?page=2 Go to a different page of the results.
paginate int /api/v3/hearing-note?paginate=100 Set the number of results returned per page. 1000 max per page limit.

Hearings

create

Adds a new hearing to our system.

method POST
endpoint /api/v3/hearing
return Hearing Model

Parameters

Key Type Requirement Description Values
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 array required Returns an array with date (YYYY-MM-DD 00:00:00.000000), timezone_type, and timezone keys. Timezone is incorrectly always the server timezone and should be ignored.
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.
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/v3/hearing/{id}
return Hearing Model

Parameters

Key Type Requirement Description Values
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 array required Returns an array with date (YYYY-MM-DD 00:00:00.000000), timezone_type, and timezone keys. Timezone is incorrectly always the server timezone and should be ignored.
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.
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/v3/hearing/{id}
return Hearing Model

list

Returns an array containing available hearings in our system.

method GET
endpoint /api/v3/hearing
return Hearing Model Collection

Filters

Filter Format Example Description Values
page int /api/v3/hearing?page=2 Go to a different page of the results.
paginate int /api/v3/hearing?paginate=50 Set the number of results returned per page. Default 50. 1000 per page limit.

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/v3/hearing/assign
return Basic Response

Parameters

Key Type Requirement Description Values
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/v3/hearing/unassign
return Basic Response

Parameters

Key Type Requirement Description Values
hearing_id int required Assure's ID for the hearing you would like to remove an attorney from.

Judges

view

Show details related to a judge in our system.

method GET
endpoint /api/v3/judge/{id}
return Judge Model

list

Returns an array containing available judges in our system.

method GET
endpoint /api/v3/judge
return Judge Model Collection

Locations

view

Show details related to a location in our system.

method GET
endpoint /api/v3/location/{id}
return Location Model

list

Returns an array containing available locations in our system.

method GET
endpoint /api/v3/location
return Location Model Collection

Data Models

Basic Response

The basic format of a JSON reponse returned by the API. Except when downloading files, all requests returned are in this format with a Content-Type header of "application/json". Successful requests to download files send only file data in the request with a Content-Type header (and other file specific headers) based on the file data. The data field contains the data specific to the request, such as the returned model or an array of models.

Parameters

Key Type Description Values
success int Returns 1 on a successful call or 0 when we were unable to complete the request.
message string Any additional information about the request, including information about the error that occurred if applicable.
code int The HTTP status code returned. Toggle Possible Values
data mixed Any data the request needs to return. This will be an empty value (type of empty value depends on the endpoint) if the response does not have any data to return.
pagination conditional An array of fields for handling paging results. Only available on list endpoints when multiple results are expected. Toggle Possible Values

Attorney

Base model of an attorney.

Parameters

Key Type Description Values
id int Assure's ID for this attorney.
external_id string If attorney works for your firm, you can provide an external ID for the attorney to make lookups easier on your end. If one of your attorneys is attending the hearing and you have provided an external ID, it will be listed here.
first_name string First name of the attorney attending the hearing.
last_name string Last name of the attorney attending the hearing.

Brief

Base model of a brief.

Parameters

Key Type Description Values
id int Assure's ID for the brief.
owner association The brief owner's information.
claimant_firstname string The brief claimant's first name.
claimant_lastname string The brief claimant's last name.
status_name string The brief's status.
hearing association The hearing this brief is attached to.
assigned association The brief assigned's information.
sub_assigned association The brief sub assigned's information.
brief_files association Files uploaded to the brief.
due_at string The date the brief is due. YYYY-MM-DD HH:MM:SS.
completed_at string If the brief was completed this field contains the date and time it was cancelled at. YYYY-MM-DD HH:MM:SS.

Case

Base model of a case.

Parameters

Key Type Description Values
id int Assure's ID for this case.
hearing_id int Assure's hearing ID that this case is attached to.
first_name string First name of the claimant.
middle_name string Middle name or initial of the claimant.
last_name string Last name of the claimant
client_ssn string SSN of the claimant. Only the first 5 digits provided will be used when updating, any formatting will be stripped. The last four of the SSN that originate from the status report can not be changed on normal imported cases. When creating or updating State Agency cases the full SSN will be updated.
owner_firm association The owning firm's information.
hearing_date string Date of the hearing. YYYY-MM-DD 00:00:00.
hearing_time string 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.
hearing_timezone string The timezone of the hearing location.
location_id int Hearing location id.
location association Case location information. Uses the location model.
case_status string The current status of the case.
case_status_date string Date of the last status change. YYYY-MM-DD HH:MM:SS.
claim_type int The type of claim for this case. Toggle Possible Values
judge_id int The ALJ's ID for the case.
judge association The judge's information.
require_ve boolean Whether or not a vocational expert is required for this case.
require_me boolean Whether or not a medical expert is required for this case.
t2_decision string The T2 decision for this case. Toggle Possible Values
t16_decision string The T16 decision for this case. Toggle Possible Values
ssn_updated boolean Whether or not the case's full SSN has been set.
case_file_exhibited association The attached Exhibited CaseFile if available.
case_file_all association The attached All CaseFile if available.
created_at string Date the file was uploaded to Assure before being sent to the ERE. YYYY-MM-DD HH:MM:SS.

CaseFile

Base model of a case file. Case files are generated PDF files created from files on the ERE. A CaseFile model holds information used for generating the PDFs and tracking progress, it is not an indication of an actual downloadable file existing. If there is an actual file available for this case file it is linked by the file_id field. Also known as ERE Case Files.

Parameters

Key Type Description Values
id int Assure's ID for this ERE file.
case_id int The ID of the case this file will be attached to. Required if hearing_id is empty.
hearing_id int The ID of the case this file will be attached to. Required if case_id is empty.
file_id int The ID of the file connected to this case file.
type int The case file type ID. Toggle Possible Values
status int The status ID. Toggle Possible Values
status_message string The status message related to the current status.
update_completed_at string The last time we completed downloading new updates to this case file. YYYY-MM-DD HH:MM:SS.
last_update_check string The date we last checked the ERE to see if an updated file was available. YYYY-MM-DD HH:MM:SS.
last_change string The day of the last time a change was made to this case file on the ERE. YYYY-MM-DD 00:00:00.
created_at string Date the file was uploaded to Assure before being sent to the ERE. YYYY-MM-DD HH:MM:SS.

DocPreHearingChecklist

Base model of a pre-hearing checklist.

Parameters

Key Type Description Values
id int Assure's ID for this pre-hearing checklist.
created_at date The date the pre-hearing checklist was created. YYYY-MM-DD HH:MM:SS.

DocType

Base model of a document type used by File.

Parameters

Key Type Description Values
id int Assure's ID for this document type.
name string The name of this document type.
description string The description of this document type.

EreFile

Base model of an ERE file. ERE files hold information about a real file uploaded to the ERE through Assure. ERE files are linked to real files by the file_id field.

Parameters

Key Type Description Values
id int Assure's ID for this ERE file.
case_id int The ID of the case this file is attached to.
document_type string The ERE document type ID. Toggle Possible Values
treatment_source string The treatment source of the document. Required when document_type is 0001 or 3157. 57 character limit, only accepts a-Z, 0-9 and spaces.
from_date string The from date of the document. Required when document_type is 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
to_date string The from date of the document. Required when document_type is 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
document_date string The date of the document. Required when document_type is anything other than 0001 or 3157. Accepts M/DD/YYYY no leading zeros. Returns YYYY-MM-DD HH:MM:SS.
notes string Notes about the document. 40 character limit, only accepts a-Z, 0-9 and spaces.
name string The unique generated file name.
name_original string The original name provided for the file.
status int The current status ID of the file upload to the ERE. Toggle Possible Values
status_message string The status message related to the upload of the file to the ERE.
state string The state from the ERE for the uploaded file.
destination string The destination from the ERE for the uploaded file.
client_ssn string The client SSN from the ERE for the uploaded file.
rf string The RF from the ERE for the uploaded file.
dr string The DR from the ERE for the uploaded file.
tracking_number string The tracking number from the ERE for the uploaded file.
ere_submit_date string The date and time the file was uploaded to the ERE. YYYY-MM-DD HH:MM:SS.
file_id int The ID of the file this ERE file is connected to. This field is only present when an existing file on Assure was sent to the ERE without reuploading.
size int Size of the file in bytes.
created_at string Date the file was uploaded to Assure before being sent to the ERE. YYYY-MM-DD HH:MM:SS.

File

Base model of a file.

Parameters

Key Type Description Values
id int Assure's ID for this file.
doc_type_id int The doc type id for this file.
file_type int The doc type id for this file.
size string Size of the file in bytes.
created_at date Date the file was uploaded.

Hearing

Base model of a hearing.

Parameters

Key Type Description Values
id int Assure's ID for this hearing.
client_first_name string First name of the claimant.
client_last_name string Last name of the claimant
client_ssn int SSN of the claimant. Nine digits only.
hearing_date array Returns an array with date (YYYY-MM-DD 00:00:00.000000), timezone_type, and timezone keys. Timezone is incorrectly always the server timezone and should be ignored.
hearing_time string 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.
owner_firm association The owning firm's information.
location_id int Hearing location id.
location association Hearing location information. Uses the location model.
user_advocate_attending int The attending attorney's ID for this hearing.
suggested_attendee string The suggested attendee to attend this hearing.
judge_id int The ALJ's ID for the hearing.
judge association The judge's information.
require_ve boolean Whether or not a vocational expert is required for this hearing.
require_me boolean Whether or not a medical expert is required for this hearing.
require_vtc boolean Whether or not this hearing is over video teleconference.
hearing_outcome int The final outcome of the hearing. 1 = Unfavorable Hearing Outcome, 2 = Partially Favorable Hearing Outcome, 3 = Favorable Hearing Outcome
note string Add a new note to this hearing.
initials string Initials if a note is being added with this hearing.
cancelled_at string 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.
hearing_files association Files uploaded to the hearing.
doc_pre_hearing_checklist association Pre-hearing checklist attached to the hearing.
doc_medical_records association Outstanding medical record information attached to the hearing. These are created when a hearing is scheduled but more medical records are expected according to the person who completed the Pre-hearing Information. These are not actual medical record requests that are collected by a medical record provider within Assure.
contact_attempts association Contact attempts attached to the hearing.
firm_source string The name and symbol of the firm source.

HearingNote

Base model of a hearing note.

Parameters

Key Type Description Values
id int Assure's ID for this hearing note.
hearing_id int Assure's ID for the hearing this note is attached to.
content string The content of the note.
initials string The initials provided by the user that created this note.
created_at string Date the note was added. YYYY-MM-DD HH:MM:SS.

Judge

Base model of a hearing judge.

Parameters

Key Type Description Values
id int Assure's ID for this judge.
first_name string First name of the judge.
last_name string Last name of the judge.
region string The region this judge is in.
office string The office this judge works from.

Location

Base model of a hearing location.

Parameters

Key Type Description Values
id int Assure's ID for the location.
address_street_1 string Street address of the hearing location.
address_street_2 string Building number, suite, floor, etc. of the hearing location.
address_city string City of the hearing location.
address_state string State of the hearing location.
address_zip string Zip code of the hearing location.
utc_offset int UTC offset of the city where the hearing takes place. This is the offset without daylight savings in affect. e.g. -6