QBOS REST API documentation for MSPQ

This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.

Additional resources, information about this guide

Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us at: pkajaani@qbos.com. We appreciate your help.

Getting Started

To place any request in a QBOS API application from a third party application you need to first authenticate your user account and set/calculate values for the following request headers: x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth

Custom resource vs. standard resource URI format

Custom resource (a.k.a applet) URI contains the resource vendor id in place of "/o/" in the standard object URI. Compare: .../v1/o/...with .../v1/{vendor_id}/...

MSPQ properties

Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.

Name	Type	Max Length	Numeric	Required For POST	Filterable	Default	Description
_client_Id	bigint		Yes			NULL	This is the Data Org Id.
_owner_Id	bigint		Yes		Yes	NULL	This is the user id of the record owner. Defaults to the creatorOpid.
_creator_Opid	bigint		Yes		Yes	NULL	This is the user id of the original record submitter.
_create_Date	datetime		No	{timestamp}			Not enterable upon Insert. System sets this date upon record creation.
status_id	int		Yes		Yes	5842	The status id of the record. Taken from the Life Cycle statuses in ADS.
_status_Change_Date	datetime		No			NULL	Not enterable. System sets this date whenever the statusid is changed.
Workers_Comp	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Auto_Accident	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Please_Note_Auto	nvarchar	1000			Yes	NULL
Injury	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Please_Note_Injury	nvarchar	1000			Yes	NULL
Black_Lung	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Spouse_Employed_20	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Spouse_Employed_100	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Dialysis	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
COBRA	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Thirty_Months	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Insured_First_Name	nvarchar	35			Yes	NULL
Insured_Last_Name	nvarchar	35			Yes	NULL
Employer_Name	nvarchar	70			Yes	NULL
Insurance_Name	nvarchar	70			Yes	NULL
Policy_Number	nvarchar	25			Yes	NULL
Address1	nvarchar	50			Yes	NULL
City	nvarchar	40			Yes	NULL
State_Code	nvarchar	2			Yes	NULL	This property is populated by a Type 2 Value List. Click here for the appropriate API and sample of value options for this column.
Zipcode	nvarchar	9			Yes	NULL
County	nvarchar	50			Yes	NULL
Completed_By	integer		Yes		Yes	NULL
Checkbox	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Working_Aged_Insurance	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Disability	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Public_Health_System	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
PHS_Authorized	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
ESRD	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Liability_Insurance	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Workers_Comp_Litigation	bit		Yes		Yes	NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Completed_By_Name	nvarchar	70			Yes	NULL

MSPQ Relationships

Parent and Child relations to MSPQ.

Note that the only Required status on relationships that affect a POST of an object are on the parent relations. A Required status on a child relation is only meaningful when POSTing the child object.

Linking during POST: a custom object record can be linked to a parent or child record (custom or standard) during POST by including (in the payload) the realtion id paired with the parent or child object record being linked to. For example: { "REl_3233" : 1832 } Multiple links may be created in the same POST.

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_3233	1-1	Yes	Patient_Payer_Info
Parent Relations ↑ MSPQ ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To

Read MSPQ by id:

GET https:/.../v1/517090/MSPQ/{id}

Response codes:

200 - OK
404 - Not found or user does not have permission to access resources of this type.
400 - Client error
500 - Server error

Response data: GET https:/.../v1/517090/MSPQ/1

Unauthorized request.

Read MSPQ by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/MSPQ[?{filter}]

Response codes:

400 - Client error
500 - Server error
404 - Not found or user does not have permission to access resources of this type.
200 - OK

Response data: GET https:/.../v1/517090/0/506764/links/MSPQ

Unauthorized request.

Read MSPQ by filter:

GET https:/.../v1/517090/MSPQ[?{filter}]

Response codes:

200 - OK
400 - Client error
404 - Not found or user does not have permission to access resources of this type.
500 - Server error

Response data: GET https:/.../v1/517090/MSPQ?id=1

Unauthorized request.

Create MSPQ:

POST https:/.../v1/517090/MSPQ

Request data [See properties]:

Response codes:

201 - OK [See response data]
400 - Client error
500 - Server error

Update MSPQ:

PUT https:/.../v1/517090/MSPQ/{id}

Request data [See properties]:

Response codes:

200 - OK Content returned [See response data]
204 - OK No content
400 - Client error
404 - Not found
500 - Server error

Delete MSPQ:

DELETE https:/.../v1/517090/MSPQ/{id}

The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

Create Link for MSPQ:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/MSPQ/{id}

{relation_id} can indicate either a parent or a child relation.

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

Delete Link for MSPQ:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/MSPQ/{id}

Deleting a link from MSPQ down to a child object must be explicitly indicated by negating the relation id:

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/MSPQ/{id}

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

QBOS REST API documentation (MSPQ)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

MSPQ properties

MSPQ Relationships

Read MSPQ by id:

GET https:/.../v1/517090/MSPQ/{id}

Read MSPQ by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/MSPQ[?{filter}]

Read MSPQ by filter:

GET https:/.../v1/517090/MSPQ[?{filter}]

Create MSPQ:

POST https:/.../v1/517090/MSPQ

Update MSPQ:

PUT https:/.../v1/517090/MSPQ/{id}

Delete MSPQ:

DELETE https:/.../v1/517090/MSPQ/{id}

Create Link for MSPQ:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/MSPQ/{id}

Delete Link for MSPQ:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/MSPQ/{id}

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/MSPQ/{id}