Reports 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 active Organisations that the user can access.

Request:

GET /reports/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”).
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","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}
{"orgId":"2","orgName":"Client Organisation","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 active Organisation.

Request:

GET /reports/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”).
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","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87"}

List Organisations within an IGRP

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

Request:

GET /reports/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 active Organisations that the user can access.

orgId (int) - Organisation ID.
orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
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","orgName":"Example Inc","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"all","orgTypeName":"All Data","orgTypeOrder":"1"}
{"orgId":"103","orgName":"Egypt","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","orgName":"France","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","orgName":"USA","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","orgName":"North West USA","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"region","orgTypeName":"Regions","orgTypeOrder":"3"}

Read IGRP Organisation Config

Returns the properties of a particular active Organisation within an IGRP.

Request:

GET /reports/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 active Organisation.

orgId (int) - Organisation ID.
orgName (string) - Friendly name of the Organisation (e.g. “Infinity Tracking”).
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","orgName":"USA","brandingId":"1","brandingName":"Infinity","logoFilename":"2f883544-d320-4418-bb6c-b8d93bc97854.png","landingDomain":"infinity-tracking.com","primaryColor":"#E52D87","orgTypeCode":"country","orgTypeName":"Countries","orgTypeOrder":"2"}