Groups take many forms and can come together formally or informally. As such they can be characterised in a multitude of ways.
A user created by the Promana API might, as in the real world, be an individual end-user/customer, or, they may be part of a company, a member of a group such as an internal department, a team – the list could go on.
Promana recognises a defined set of group types and allows the API consumer to create its own hierarchy of groups of any type within that set.
When Promana references a group, it is referencing any type of grouping of individuals, from government bodies to companies to informal teams.
There is no requirement to use Promana’s group types, but there are advantages to doing so.
By default, as a Promana API consumer, you are represented in Promana data as an Organisation entity. Not to be confused with any other type of “organisation”.
When creating groups or defining users, the Group type code must be passed.
Group type code | Description |
---|---|
GOVT | Government |
FEDERAL_GOV | Federal Government |
REGIONAL_GOV | Regional Government |
LOCAL_GOV | Local Government |
AUTHORITY | Authority |
INST | Institution |
COMPANY | Company |
HEAD_OFFICE | Head Office |
BRANCH | Branch Office |
REGION_OFFICE | Regional Office |
SUBSIDIARY | Subsidiary |
GROUP_HQ | Group Headquarters |
DEPT | Department |
AD_HOC | Ad hoc group |
TEAM | Team |