Reports 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 Organisation Types defined for an IGRP.
Request:
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 and orgTypeName.
Response:
Returns a list of Organisation Types defined for an IGRP.
- orgTypeCode (string) - The unique code for the organisation 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.
Read Organisation Type
Returns a single Organisation Type defined for an IGRP.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- orgTypeCode (string) - The code that represents this organisation’s type.
Response:
Returns a single Organisation Type defined for an IGRP.
- orgTypeCode (string) - The unique code for the organisation 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.
Create Organisation Type
Creates a new Organisation Type for a given IGRP.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
POST Params
- 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.
Response:
Update Organisation Type
Updates an existing Organisation Type for a given IGRP.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- orgTypeCode (string) - The code that represents this organisation’s type.
POST Params
- orgTypeName (string) OPTIONAL - Friendly name of the organisation type.
- orgTypeOrder (int) OPTIONAL - A nominal display order for organisation types. Allows you to list organisations of each type together.
Response:
Delete Organisation Type
Deletes an existing Organisation Type for a given IGRP.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- orgTypeCode (string) - The code that represents this organisation’s type.