Config API Version 2 Organisation Types

Introduction

Please note that Organisation Types are only provided for Enterprise customers.

Organisations may be used to divide an IGRP into different business units or departments, segmenting activity between these units (see the section on Segments for more details).

While all permissions are managed through the organisation structure, Organisation Types are a way of grouping different organisations together, regardless of the hierarchy, and displaying complex organisational structures in a simpler, flat navigational structure.

For example, an international company may have different sales areas each with their own users and data. This might include:

Example Inc. > USA > North West Example Inc. > Europe > Western Europe > France Example Inc. > Africa > Egypt

In order to display a list of data by country, we need some way to identify which of these organisations are countries and which are regions, etc.

When creating the organisations called “USA”, “France” and “Egypt”, we can assign them an organisation type of “country” within our IGRP and from that point on we can list any organisation that represents a country.

List Organisation Types

Returns a list of defined Organisation Types for a specified IGRP.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/organisationTypes

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

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 Organisation Types list may be filtered by any of the returned fields.

Sort Types

The Organisation Types list may be sorted by any of the returned fields. By default the list is sorted by orgTypeOrder.

Response:

Returns a list of Organisation Types that the user can access.

orgTypeCode (string) - The code that represents this organisation’s type.
orgTypeName (string) - Friendly name of the organisation type.
orgTypeOrder (int) - A nominal display order for organisation types. Allows you to list organisations of each type together.

{"orgTypeCode":"all","orgTypeName":"All Data","orgTypeOrder":"1"}
{"orgTypeCode":"country","orgTypeName":"Countries","orgTypeOrder":"2"}

List Organisations within an IGRP

Returns a list of Organisations that the user can access within an IGRP.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/organisations

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

rootOrgId (int) OPTIONAL - If provided, only show organisations below this one in the hierarchy.
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. By default the list is sorted by orgTypeOrder then by orgName.

Response:

Returns a list of Organisations that the user can access.

orgId (int) - Organisation ID.
orgRef (int) - Client reference for the Organisation.
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.
orgTypeCode (string) - The code that represents this organisation’s type.
orgTypeName (string) - Friendly name of the organisation type.
orgTypeOrder (int) - A nominal display order for organisation types. Allows you to list organisations of each type together.

{"orgId":"100","orgRef":"","orgName":"Example Inc","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","orgTypeCode":"all","orgTypeName":"All Data","orgTypeOrder":"1"}
{"orgId":"103","orgRef":"eg","orgName":"Egypt","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"country","orgTypeName":"Countries","orgTypeOrder":"2"}
{"orgId":"102","orgRef":"fr","orgName":"France","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"country","orgTypeName":"Countries","orgTypeOrder":"2"}
{"orgId":"101","orgRef":"us","orgName":"USA","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"country","orgTypeName":"Countries","orgTypeOrder":"2"}
{"orgId":"201","orgRef":"us_nw","orgName":"North West USA","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"region","orgTypeName":"Regions","orgTypeOrder":"3"}

Read Organisation Config

Returns the properties of a particular Organisation within an IGRP.

Request:

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

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
ORG SPECIFIER (int) - Organisation ID.

Response:

Returns the properties of a particular Organisation.

orgId (int) - Organisation ID.
orgRef (int) - Client reference for the Organisation.
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.
orgTypeCode (string) - The code that represents this organisation’s type.
orgTypeName (string) - Friendly name of the organisation type.
orgTypeOrder (int) - A nominal display order for organisation types. Allows you to list organisations of each type together.

{"orgId":"101","orgRef":"us","orgName":"USA","orgStatus":"200","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"country","orgTypeName":"Countries","orgTypeOrder":"2"}

Link Organisation

Links an Organisation to an IGRP and defines its Type.

Request:

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

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
ORG SPECIFIER (int) - Organisation ID.

POST Params

orgTypeCode (string) - The orgTypeCode to assign to this organisation. This must be a valid Type for the specified IGRP.
orgRef (int) OPTIONAL - Client reference for the Organisation.

Response:

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

HTTP 204 - NO CONTENT

Unlink Organisation

Unlinks an Organisation from an IGRP.

Request:

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

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
ORG SPECIFIER (int) - Organisation ID.

Response:

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

HTTP 204 - NO CONTENT