QBOS REST API documentation for CASAFET

The CASAFET API allows client applications to maintain CASAFET data record sets.

Audience

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

CASAFET 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	5581	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.
High_drug_area	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.
High_crime_area	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.
Dangerous_pets	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.
High_traffic_area	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.
High_pollution_level	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.
Foul_odors	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.
Soiled_living_area	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.
Sewer_disposal	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.
Water_supply	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.
Food_storage	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.
Fire_exit_plan	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.
Fire_exit_plan_teaching	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.
Fire_exit_plan_no_teaching_reason	nvarchar	100			Yes	NULL
Smoke_alarms	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.
Smoke_alarms_teaching	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.
Smoke_alarms_no_teaching_reason	nvarchar	100			Yes	NULL
CM_alarm	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.
CM_alarm_teaching	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.
CM_alarm_no_teaching_reason	nvarchar	100			Yes	NULL
Wandering_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.
Wandering_risk_teaching	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.
Wandering_risk_no_teaching_reason	nvarchar	100			Yes	NULL
Obstructed_entrance_exit	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.
Obstructed_entrance_exit_teaching	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.
Obstructed_entrance_exit_no_teaching_reason	nvarchar	100			Yes	NULL
Obstacle	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.
Obstacle_teaching	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.
Obstacle_no_teaching_reason	nvarchar	100			Yes	NULL
Pet_in_home	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.
Pet_in_home_teaching	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.
Pet_in_home_no_teaching_reason	nvarchar	100			Yes	NULL
Patient_smokes	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.
Patient_smokes_teaching	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.
Patient_smokes_no_teaching_reason	nvarchar	100			Yes	NULL
Rodent_infest	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.
Rodent_infest_teaching	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.
Rodent_infest_no_teaching_reason	nvarchar	100			Yes	NULL
Oxygen_is_present	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.
Oxygen_is_present_teaching	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.
Oxygen_is_present_no_teaching_reason	nvarchar	100			Yes	NULL
Guns_in_home	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.
Guns_in_home_teaching	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.
Guns_in_home_no_teaching_reason	nvarchar	100			Yes	NULL
Elder_abuse	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.
Elder_abuse_teaching	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.
Elder_abuse_no_teaching_reason	nvarchar	100			Yes	NULL
Reported_issues	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_administration_note	nvarchar	3000			Yes	NULL
Pet_kind_note	nvarchar	100			Yes	NULL
High_drug_area_teaching	nvarchar	20			Yes	NULL
High_drug_area_teaching_reason	nvarchar	100			Yes	NULL
High_crime_area_teaching	nvarchar	20			Yes	NULL
High_crime_area_teaching_reason	nvarchar	100			Yes	NULL
Dangerous_pets_teaching	nvarchar	20			Yes	NULL
Dangerous_pets_teaching_reason	nvarchar	100			Yes	NULL
High_traffic_area_teaching	nvarchar	20			Yes	NULL
High_traffic_area_teaching_reason	nvarchar	100			Yes	NULL
High_pollution_level_teaching	nvarchar	20			Yes	NULL
High_pollution_level_teaching_reason	nvarchar	100			Yes	NULL
Foul_odors_teaching	nvarchar	20			Yes	NULL
Foul_odors_teaching_reason	nvarchar	100			Yes	NULL
Soiled_living_area_teaching	nvarchar	20			Yes	NULL
Soiled_living_area_teaching_reason	nvarchar	100			Yes	NULL
Sewer_disposal_teaching	nvarchar	20			Yes	NULL
Sewer_disposal_teaching_reason	nvarchar	100			Yes	NULL
Water_supply_teaching	nvarchar	20			Yes	NULL
Water_supply_teaching_reason	nvarchar	100			Yes	NULL
Food_storage_teaching	nvarchar	20			Yes	NULL
Food_storage_teaching_reason	nvarchar	100			Yes	NULL
Is_declined	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.
Is_noChange	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.

CASAFET Relationships

Parent and Child relations to CASAFET.

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

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To
REL_2950	1-1	Yes	CA_Assessment
Parent Relations ↑ CASAFET ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_3049	1-Many		Teaching_Safety_Medication_Admin
REL_2930	1-Many		Assessment_Issue
REL_3050	1-Many		CP_POC_Issue
REL_3051	1-1		Notes

Read CASAFET by id:

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

Unauthorized request.

Read CASAFET by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/CASAFET[?{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/2950/4/links/CASAFET

Unauthorized request.

Read CASAFET by filter:

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

Unauthorized request.

Create CASAFET:

POST https:/.../v1/517090/CASAFET

Request data [See properties]:

Response codes:

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

Update CASAFET:

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

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

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

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

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

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

Response codes:

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

QBOS REST API documentation (CASAFET)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

CASAFET properties

CASAFET Relationships

Read CASAFET by id:

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

Read CASAFET by parent id:

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

Read CASAFET by filter:

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

Create CASAFET:

POST https:/.../v1/517090/CASAFET

Update CASAFET:

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

Delete CASAFET:

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

Create Link for CASAFET:

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

Delete Link for CASAFET:

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

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