API Documentation v2

Introduction

Welcome to the Assure API.

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 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 request to the /api/v2/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.

Endpoints

Hearings

create

Adds a new hearing to our system.


Parameters

update

Update an existing hearing in our system.


Parameters

view

Show details related to a hearing in our system.

list

Returns an array containing available hearings in our system.

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.


Parameters

unassign

Make a request to unassign an attorney from a hearing.


Parameters

Locations

view

Show details related to a location in our system.

list

Returns an array containing available locations in our system.

Judges

view

Show details related to a judge in our system.

list

Returns an array containing available judges in our system.

Attorneys

view

Show details related to an attorney in our system.

list

Returns an array containing available attorneys in our system.

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.


Parameters

DocTypes

view

Show details related to a doc type in our system.

list

Returns an array containing available document types in our system.

DocPreHearingChecklists

view

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

Briefs

view

Show details related to a brief request in our system.

list

Returns an array containing available brief requests in our system.

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.


Parameters

list

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


Parameters

ReadyToScheduleData

create

Adds a new ready to schedule hearing to our system. A RTS hearing is a hearing with no location, date or time. If a location, date and time are provided this endpoint will instead create a new hearing request.


Parameters

update

Update an existing ready to schedule hearing in our system.


Parameters

DocPreHearingInfo

create

Submit Pre-Hearing Information for a hearing. All pre-hearing information is connected to a hearing and is used to add additional client and case rep information when a hearing requires it. In the Assure portal the pre-hearing information is displayed with other hearing information and the pre-hearing information contains fields to confirm information on the hearing is accurate. It is recommended that you also display relevant client information from the attached hearing when working with pre-hearing information and offer options for the user to update the attached hearing in the event that some client information (such as a misspelled name) does not match the information they have.


Parameters

update

Update existing pre-hearing information in our system. The ID provided should be the hearing ID the pre-hearing information is attached to. You may provide all fields with any changes or only the fields you are changing.


Parameters

view

Show details from the pre-hearing information for a hearing in our system. The ID provided should be the hearing ID the pre-hearing information is attached to.

Data Models

Basic Response

Basic response format an API call will return.

Parameters

Hearing

Base model of a hearing.

Parameters

Location

Base model of a hearing location.

Parameters

Judge

Base model of a hearing judge.

Parameters

Attorney

Base model of an attorney.

Parameters

File

Base model of a file.

Parameters

DocType

Base model of a document type used by File.

Parameters

DocPreHearingChecklist

Base model of a pre-hearing checklist.

Parameters

Brief

Base model of a brief.

Parameters

HearingNote

Base model of a hearing note.

Parameters

HearingCandidate

Base model of a hearing candidate relation.

Parameters

ReadyToScheduleData

Base model of a ready to schedule hearing data.

Parameters

DocPreHearingInfo

Base model for pre-hearing info.

Parameters