Config API Version 2 Organisations

Introduction

An Organisation is a company or department that is used to contain a group of users.

List Organisations

Returns a list of Organisations that the user can access.

Request:

GET /config/v2/organisations

GET Params

Filter Types

The Organisations list may be filtered by any of the returned fields.

Sort Types

The Organisations list may be sorted by any of the returned fields.

Response:

Returns a list of Organisations that the user can access.

{"orgId":"1","orgName":"Infinity Tracking","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}
{"orgId":"2","orgName":"Client Organisation","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}

Read Organisation Config

Returns the properties of a particular Organisation.

Request:

GET /config/v2/organisations/{ORG SPECIFIER}

URL Path Params

Response:

Returns the properties of a particular Organisation.

{"orgId":"1","orgName":"Infinity Tracking","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}

Create Organisation

Creates a new Organisation. Note that all new Organisations must be created under an existing parent Organisation. You may optionally specify a type code for this organisation within one or more existing IGRPs (see “Organisation Types”).

Request:

POST /config/v2/organisations

POST Params

Response:

Returns the HTTP 201 (Created) status code if successful.

HTTP 201 - CREATED

Returns the ID of the new organisation in the response body:

{"orgId":"123"}

Update Organisation Config

Updates the properties of an existing Organisation.

Request:

POST /config/v2/organisations/{ORG SPECIFIER}

URL Path Params

POST Params

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT

Delete Organisation

Deletes an existing Organisation.

Request:

DELETE /config/v2/organisations/{ORG SPECIFIER}

URL Path Params

Response:

Returns the HTTP 204 (No Content) status code if delete successful.

HTTP 204 - NO CONTENT

List Organisation branding options

Lists the available branding options for an Organisation.

Request:

GET /config/v2/organisations/{ORG SPECIFIER}/branding

URL Path Params

GET Params

Filter Types

The Branding Options list may be filtered by any of the returned fields.

Sort Types

The Branding Options list may be sorted by any of the returned fields.

Response:

Returns the available branding options for this Organisation.

{"brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}
{"brandingId":"2","brandingName":"Client","logoFilename":"ab7009ed-e572-4e6b-b170-d09dcb2af682.jpg","landingDomain":"example.com","primaryColor":"#000000"}

List Parent Organisations

Lists all Organisations that are parents of the specified Organisation.

Request:

GET /config/v2/organisations/{ORG SPECIFIER}/parents

URL Path Params

GET Params

Filter Types

The Parent Organisations list may be filtered by any of the returned fields.

Sort Types

The Parent Organisations list may be sorted by any of the returned fields.

Response:

Returns the list of all Organisations that are parents of the specified Organisation.

{"orgId":"1","orgName":"Infinity Tracking","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}
{"orgId":"2","orgName":"Client Organisation","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}

List Child Organisations

Lists all Organisations that are children of the specified Organisation.

Request:

GET /config/v2/organisations/{ORG SPECIFIER}/children

URL Path Params

GET Params

Filter Types

The Child Organisations list may be filtered by any of the returned fields.

Sort Types

The Child Organisations list may be sorted by any of the returned fields.

Response:

Returns the list of all Organisations that are children of the specified Organisation.

{"orgId":"1","orgName":"Infinity Tracking","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}
{"orgId":"2","orgName":"Client Organisation","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}

Set Parent Organisation

Links the specified Organisation exclusively to another Organisation.

Request:

PUT /config/v2/organisations/{ORG SPECIFIER}/parents

URL Path Params

PUT Params

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT

Add Parent Organisation

Links the specified Organisation to another Organisation.

Request:

POST /config/v2/organisations/{ORG SPECIFIER}/parents

URL Path Params

POST Params

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT

Remove Parent Organisation

Unlinks the specified Organisation from another Organisation.

Request:

DELETE /config/v2/organisations/{ORG SPECIFIER}/parents

URL Path Params

DELETE Params

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT