QBOS REST API documentation for CASW

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}/...

CASW 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	5584	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.
Ethnicity	nvarchar	50			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.
Education_level	nvarchar	30			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.
Occupation	nvarchar	100			Yes	NULL
Hobbies	nvarchar	100			Yes	NULL
Religious_affiliation	nvarchar	100			Yes	NULL
Place_of_birth	nvarchar	100			Yes	NULL
Marriages	nvarchar	100			Yes	NULL
Spiritual_support	nvarchar	100			Yes	NULL
Suicide_risk_patient	nvarchar	20			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.
Suicide_risk_PCG	nvarchar	20			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.
Advanced_directive	nvarchar	20			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.
Living_will	nvarchar	20			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.
DPOA	nvarchar	20			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.
DNR	nvarchar	20			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.
Medicare	nvarchar	20			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.
Medicaid	nvarchar	20			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.
Meals_on_wheels	nvarchar	20			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.
State_assistance	nvarchar	20			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.
Funeral_arrangement	nvarchar	20			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.
Social_work	nvarchar	20			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.
Place_of_upbringing	nvarchar	20			Yes	NULL
Suicide_risk_note	nvarchar	100			Yes	NULL
Safety_risk	nvarchar	20			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.
Financial_needs	nvarchar	20			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.
Respite_placement_needs	nvarchar	20			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.
Community_resource_needs	nvarchar	20			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.
Legal_needs	nvarchar	20			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.
Funeral_needs	nvarchar	20			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.
Volunteer_needs	nvarchar	20			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.
Interpersonal_support_needs	nvarchar	20			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.
Anticipatory_grief_needs	nvarchar	20			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.
Other_label	nvarchar	20			Yes	NULL
Other_note	nvarchar	100			Yes	NULL
Advanced_directives_polst	nvarchar	20			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.
Guardianship	nvarchar	20			Yes	NULL
Conservatorship	nvarchar	20			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.
State_assistance_ssi	nvarchar	20			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.
Safety_risk_note	nvarchar	100			Yes	NULL
Financial_needs_note	nvarchar	100			Yes	NULL
Respite_placement_needs_note	nvarchar	100			Yes	NULL
Community_resource_needs_note	nvarchar	100			Yes	NULL
Legal_needs_note	nvarchar	100			Yes	NULL
Funeral_needs_note	nvarchar	100			Yes	NULL
Volunteer_needs_note	nvarchar	100			Yes	NULL
Interpersonal_support_needs_note	nvarchar	100			Yes	NULL
Anticipatory_grief_needs_note	nvarchar	100			Yes	NULL
Suicide_risk_PCG_note	nvarchar	100			Yes	NULL
PrimaryCaregiverId	nvarchar	20			Yes	NULL
OtherCaregiverId	nvarchar	20			Yes	NULL
PrimaryCaregiverNote	nvarchar	500			Yes	NULL
PrimaryCaregiverRelation	nvarchar	100			Yes	NULL
OtherCaregiverRelation	nvarchar	100			Yes	NULL
OtherCaregiverNote	nvarchar	500			Yes	NULL

CASW Relationships

Parent and Child relations to CASW.

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_3158" : 1832 } Multiple links may be created in the same POST.

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_2953	1-1	Yes	CA_Assessment
Parent Relations ↑ CASW ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_3158	1-Many	Yes**	CA_SocialWork_Caregivers
REL_3148	1-1		Notes
REL_3054	1-Many		CP_POC_Issue
REL_2919	1-Many		Assessment_Issue
REL_3053	1-3		Notes

Read CASW by id:

GET https:/.../v1/517090/CASW/{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/CASW/115

Unauthorized request.

Read CASW by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/CASW[?{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/2953/614/links/CASW

Unauthorized request.

Read CASW by filter:

GET https:/.../v1/517090/CASW[?{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/CASW?id=115

Unauthorized request.

Create CASW:

POST https:/.../v1/517090/CASW

Request data [See properties]:

Response codes:

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

Update CASW:

PUT https:/.../v1/517090/CASW/{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 CASW:

DELETE https:/.../v1/517090/CASW/{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 CASW:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/CASW/{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 CASW:

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

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

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

Response codes:

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

QBOS REST API documentation (CASW)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

CASW properties

CASW Relationships

Read CASW by id:

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

Read CASW by parent id:

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

Read CASW by filter:

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

Create CASW:

POST https:/.../v1/517090/CASW

Update CASW:

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

Delete CASW:

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

Create Link for CASW:

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

Delete Link for CASW:

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

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