QBOS REST API documentation

The workgroup API allows client applications to maintain workgroup 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

workgroup properties

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

Name	Type	Max length	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 "workgroup"
title	varchar	50
description	varchar	200
_supervisor_id	bigint

Read workgroup by id:

GET https:/.../v1/o/workgroup/{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/workgroup/18034

{ "linked" : {"supervisor":[ {"type":"humanresource","id":"507528","sub_type":"","_title":"Buxton, Laura","href":"\/v1\/o\/humanresource\/507528"}],"user":[ {"type":"user","id":"507528","sub_type":"","_title":"Buxton, Laura","href":"\/v1\/o\/user\/507528"}],"privilege":[ {"type":"privilege","ids":"[]"}]}, "parent_type" : "corporate", "type" : "workgroup", "id" : 18034, "sub_type" : "", "parent_id" : 506764, "title" : "Social Worker Float", "description" : "Social Worker Float", "_supervisor_id" : 507528, "href" : "\/v1\/o\/workgroup\/18034" }

Read workgroup from parent:

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

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

Create workgroup:

POST https:/.../v1/o/corporate/506764/workgroup

Request data [See properties]:

{"workgroup": [ { "parent_type" : "corporate", "parent_id" : 506764, "property_a" : "value-a", "property" : "See workgroup properties", "property_z" : "value-z" } ] }

Response codes:

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

Update workgroup:

PUT https:/.../v1/o/workgroup/{id}

Request data [See properties]:

{"workgroup": [ { "id" : 18034, "property_a" : "value-a", "property" : "See workgroup properties", "property_z" : "value-z" } ] }

Response codes:

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

Delete workgroup:

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

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

{"workgroup": [{"id":18034}]}

Response codes:

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

Response data:

{}

QBOS REST API documentation (workgroup)

Introduction

Audience

Additional resources, information about this guide

Getting Started

workgroup properties

Read workgroup by id:

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

Read workgroup from parent:

GET https:/.../v1/o/{parent_type}/{parent_id}/links/workgroup[?{filter}]

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

Create workgroup:

POST https:/.../v1/o/corporate/506764/workgroup

Update workgroup:

PUT https:/.../v1/o/workgroup/{id}

Delete workgroup:

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