Referral Document Status

Table of Contents

Sample Request
Sample Response JSON
Notes on Values

Supportable maintains a global list of Referral Document Statuses which refer to the overall states of a Referral Process Document, such as In Process, Accepted, Rejected, etc.

Sample Request #

Headers	Authorization = Bearer [token]
Parameters	None
Body	None

GET https://connect.supportableapp.com/api/referral-document-statuses

Sample Response JSON #

Status: 200

[
  {
    "_id": "621c8ed62d1141e2a64df5a3",
    "name": "New",
    "status": true
  },
  {
    "_id": "621c8fd111ed7b97a661d584",
    "name": "In Process",
    "status": true
  },
  {
    "_id": "621c93a33b8ad1807b37962a",
    "name": "Accepted",
    "status": true
  },
  {
    "_id": "621c93a8490cb63f45c1c51a",
    "name": "Rejected",
    "status": true
  }
]

Notes on Values #

Attribute	Data Type	Description
id	string	The unique identifier of the Referral Document Status.
status	boolean	Whether the Referral Document Status is active in Supportable.
name	name	The name of the Referral Document Status as it appears in the application.