QBOS REST API documentation for CASPIR

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

CASPIR 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	5585	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.
Declines_spritual_care	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.
Religious_affiliation	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.
Relig_affil_note	nvarchar	100			Yes	NULL
Place_of_worship	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_worship_note	nvarchar	100			Yes	NULL
Worship_address	nvarchar	30			Yes	NULL
Worship_city	nvarchar	30			Yes	NULL
Place_of_worship_state	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.
Spiritual_advisor	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.
Spiritual_advisor_note	nvarchar	100			Yes	NULL
Spiritual_advisor_contact	nvarchar	20			Yes	NULL
Spiritual_advisor_phone	nvarchar	13			Yes	NULL
Support_requested	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_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.
Community_support_needs_note	nvarchar	100			Yes	NULL
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.
Anticipatory_grief_needs_note	nvarchar	100			Yes	NULL
Spiritual_care_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.
Spiritual_care_needs_note	nvarchar	100			Yes	NULL
Funeral_service_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_service_needs_note	nvarchar	100			Yes	NULL
Veteran_recognition	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.
Veteran_recognition_note	nvarchar	100			Yes	NULL
Other_label	nvarchar	20			Yes	NULL
Other_note	nvarchar	100			Yes	NULL
Spouse_family_military_serve	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.
Active_duty	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.
Combat_assignments	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.
DD214_discharge_paper	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.
Spouse_active_duty	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.
Any_immediate_family_member_in_military	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.
Military_branch	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.
War_ear_period	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.
View_exp_in_military_note	nvarchar	20			Yes	NULL
VA_enrolled	nvarchar	100			Yes	NULL
VA_benefits_received	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.
VA_benefits_medication	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.
VA_medication_hospital	nvarchar	100			Yes	NULL
VA_medication_physician	nvarchar	20			Yes	NULL
VA_medication_phone	nvarchar	20			Yes	NULL
VA_medication_email	nvarchar	20			Yes	NULL
Like_to_talk_about_benefits	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_worship_zip	nvarchar	10			Yes	NULL

CASPIR Relationships

Parent and Child relations to CASPIR.

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

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_2951	1-1	Yes	CA_Assessment
Parent Relations ↑ CASPIR ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_3055	1-Many	Yes**	SpirAct_PU
REL_2931	1-Many		Assessment_Issue
REL_3056	1-Many		CP_POC_Issue
REL_3057	1-1		Notes

Read CASPIR by id:

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

Unauthorized request.

Read CASPIR by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/CASPIR[?{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/2951/615/links/CASPIR

Unauthorized request.

Read CASPIR by filter:

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

Unauthorized request.

Create CASPIR:

POST https:/.../v1/517090/CASPIR

Request data [See properties]:

Response codes:

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

Update CASPIR:

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

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

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

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

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

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

Response codes:

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

QBOS REST API documentation (CASPIR)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

CASPIR properties

CASPIR Relationships

Read CASPIR by id:

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

Read CASPIR by parent id:

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

Read CASPIR by filter:

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

Create CASPIR:

POST https:/.../v1/517090/CASPIR

Update CASPIR:

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

Delete CASPIR:

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

Create Link for CASPIR:

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

Delete Link for CASPIR:

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

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