Config API Version 2 Organisations

Introduction

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

Each Organisation is assigned a numeric ID that can be used to reference it in the APIs.

List Organisations

Returns a list of Organisations that the user can access.

Request:

GET /config/v2/organisations

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

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 (int) - Organisation ID.
orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
orgStatus (int) - Infinity Status code indicating status of the Organisation (E.g. 200).
brandingId (int) - The ID of the chosen branding option for this Organisation.
brandingName (string) - Friendly name of the chosen branding option for this Organisation.
logoFilename (string) - The filename containing the logo to display for the Organisation.
landingDomain (string) - The Infinity Portal domain used for this Organisation.
primaryColor (string) - The main CSS color for this 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"}

Read Organisation Config

Returns the properties of a particular Organisation.

Request:

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

URL Path Params

ORG SPECIFIER (int) - Organisation ID.

Response:

Returns the properties of a particular Organisation.

orgId (int) - Organisation ID.
orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
orgStatus (int) - Infinity Status code indicating status of the Organisation (E.g. 200).
brandingId (int) - The ID of the chosen branding option for this Organisation.
brandingName (string) - Friendly name of the chosen branding option for this Organisation.
logoFilename (string) - The filename containing the logo to display for the Organisation.
landingDomain (string) - The Infinity Portal domain used for this Organisation.
primaryColor (string) - The main CSS color for this 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

parentOrgSpec (spec) - The ID of the existing parent Organisation under which to create the new Organisation (int).
orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
brandingId (int) - The ID of the chosen branding option for this Organisation. This must be a valid option inherited from one of the parent orgs.
orgTypeCodes (array) OPTIONAL - An array of per-IGRP organisation types to assign to this new organisation, keyed on the IGRP ID (see “Organisation Types”).
orgRefs (array) OPTIONAL - An array of per-IGRP organisation references to assign to this new organisation, keyed on the IGRP ID (see “Organisation Types”).

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

ORG SPECIFIER (int) - Organisation ID.

POST Params

orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
brandingId (int) - The ID of the chosen branding option for this Organisation.

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

ORG SPECIFIER (int) - Organisation ID.
deleteSubOrgs (int) OPTIONAL - A flag (1 or 0) indicating whether or not to delete all sub organisations within this org.

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

ORG SPECIFIER (int) - The ID of the Organisation for which to show branding options (int).

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

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 (int) - The ID of the branding option.
brandingName (string) - Friendly name of the branding option.
logoFilename (string) - The filename containing the logo to display.
landingDomain (string) - The Infinity Portal domain.
primaryColor (string) - The main CSS color 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

ORG SPECIFIER (int) - The ID of the Organisation to list the parents of (int).

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

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 (int) - Organisation ID.
orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
orgStatus (int) - Infinity Status code indicating status of the Organisation (E.g. 200).
brandingId (int) - The ID of the chosen branding option for this Organisation.
brandingName (string) - Friendly name of the chosen branding option for this Organisation.
logoFilename (string) - The filename containing the logo to display for the Organisation.
landingDomain (string) - The Infinity Portal domain used for this Organisation.
primaryColor (string) - The main CSS color for this 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

ORG SPECIFIER (int) - The ID of the Organisation to list the children of (int).

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

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 (int) - Organisation ID.
orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
orgStatus (int) - Infinity Status code indicating status of the Organisation (E.g. 200).
brandingId (int) - The ID of the chosen branding option for this Organisation.
brandingName (string) - Friendly name of the chosen branding option for this Organisation.
logoFilename (string) - The filename containing the logo to display for the Organisation.
landingDomain (string) - The Infinity Portal domain used for this Organisation.
primaryColor (string) - The main CSS color for this 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

ORG SPECIFIER (int) - The ID of the Organisation to link (int).

PUT Params

parentOrgSpec (spec) - The ID of the Organisation to link to (int). You may instead provide an array of parentOrgSpec to link multiple parents at once.

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

ORG SPECIFIER (int) - The ID of the Organisation to link (int).

POST Params

parentOrgSpec (spec) - The ID of the Organisation to link to (int). You may instead provide an array of parentOrgSpec to link multiple parents at once.

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

ORG SPECIFIER (int) - The ID of the Organisation to unlink (int).

DELETE Params

parentOrgSpec (spec) - The ID of the Organisation from which to unlink (int). You may instead provide an array of parentOrgSpec to unlink multiple parents at once.

Response:

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

HTTP 204 - NO CONTENT