Organizations

In general terms, an Organization is a company composed of one or more Users. Organizations are assigned a type such as Tenant, Shipper, and Vendor/Service partner. When you create a User you specify an Organization type to which they belong.

To create an Organization, call the Create Organization endpoint and pass the following parameters in the request body:

Member

Description

Remarks

organization

Specifies the type of the Organization, for example, Tenant.

description

Description of the Organization.

Request bodies are specified in JSON format. The following example request body shows how to create an Organization named Shipper:

{
  "organization": "Shipper",
  "description": "Shipper Organization"
}

User Functions

A Function defines a job role within an Organization. It highlights the role that a User performs within an Organization. In the User API, functions apply to Operations, Sales, and Corporate - HR/Finance/Commercial job roles.

To create a Function, call the Create Function endpoint and pass the following parameters in the request body:

Member

Description

Remarks

Function

Specifies the function of the User with the Organization.

Request bodies are specified in JSON format. The following example request body shows how to create a Function named Sales:

{
  "function": "FieldExecutive"
}

Designation

The designation is an Organizational title or position assigned to a User.

You can map more than one User Group to a Designation. For example, a permanent Field Executive and an Adhoc Field Executive might have the same sub-group. But from a business point of view, you want these two designations to be separate to maintain different capabilities that are assigned to each Role:

  • A User can only be assigned one designation
  • Multiple Users can be assigned the same designation
  • A designation can have multiple roles assigned/mapped to it
  • The same role can be mapped to multiple designations.

Examples of Designations are Field Associate, Facility supervisor, Vendor Manager, Fleet supervisor, etc.

To create a Designation, call the Create Designation endpoint and pass the following parameters in the request body:

Member

Description

Remarks

name

Name of the designation to create.

description

Description of the Designation to create.

Request bodies are specified in JSON format. The following example request body shows how to create a Designation named Vendor Manager:

{
  "name": "Vendor Manager",
  "description": "view usage/ activity/ performance reports (from other FPAs) of all vendors and their resource"
}

Did this page help you?