QBOS REST API documentation

The appointment_resource API allows client applications to maintain appointment_resource data including any part of its demographic 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. We appreciate your help.

Getting Started

To place any request in QBOS API application from third party application you need to authenticate 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

appointment_resource 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	Description
id	bigint				Required for GET(by id),PUT,DELETE
parent_id	bigint			yes
parent_type	nvarchar	50		yes
type	nvarchar	50			Value is "appointment_resource"
attendee_type	nvarchar	50		yes	"contact", "person", "humanresource", "applet resource type"
attendee_id	int			yes	contact id, person id, humanresource id, applet resource id
_name	nvarchar	144
_primary_sw	bit
attendance_required_sw	bit
attendance_response	int		yes		0=Pending,1=Tentative,2=Accepted,3=Declined
_attendance_response_datetime	varchar	20
href	varchar	37
href_attendee	nvarchar	67

Read appointment_resource by id:

GET https:/.../v1/o/appointment_resource/{id}

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/o/appointment_resource/1476

{ "parent_type" : "appointment", "parent_id" : 158326, "type" : "appointment_resource", "id" : 1476, "attendee_type" : "humanresource", "attendee_id" : 535505, "_name" : "Thad Mock", "_primary_sw" : 0, "attendance_required_sw" : 1, "attendance_response" : 0, "_attendance_response_datetime" : "", "href" : "\/v1\/o\/appointment_resource\/1476", "href_attendee" : "\/v1\/o\/humanresource\/535505" }

Read appointment_resource from parent:

GET https:/.../v1/o/{parent_type}/{parent_id}/links/appointment_resource[?{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

GET https:/.../v1/o/appointment/158326/links/appointment_resource

Response example is shown in XML format here even though REST API returns JSON format:

<appointment_resource><appointment_resource parent_type="appointment" parent_id="158326" type="appointment_resource" id="1475" sub_type="" _title="Mary McCoy" href="/v1/o/appointment_resource/1475"/><appointment_resource parent_type="appointment" parent_id="158326" type="appointment_resource" id="1476" sub_type="" _title="Thad Mock" href="/v1/o/appointment_resource/1476"/></appointment_resource>

Create appointment_resource:

POST https:/.../v1/o/appointment/158326/appointment_resource

Request data [See properties]:

{"appointment_resource": [ { "parent_type" : "appointment", "parent_id" : 158326, "property_a" : "value-a", "property" : "See appointment_resource properties", "property_z" : "value-z" } ] }

Response codes:

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

Delete appointment_resource:

DELETE https:/.../v1/o/appointment_resource/{id}

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

{"appointment_resource": [{"id":1476}]}