Endpoints

The Ankeri API includes a Swagger documentation that includes information on the resources of the API, with examples of inputs and outputs for each method. Note that each endpoint is explained in detail at Models part that is expandable at the bottom of the Swagger documentation.

Event handles

When looking for certain Event types and attributes the corresponding handle should be used.

Ankeri Ship profiles have the following standard events and attributes. Handles are shown bold, followed by titles. Note that handles will not change during the lifetime of an event while administrators at each company can change the titles.

deilvery: Delivery of the vessel

• vertical-sides-paint-supplier: Vertical Sides Paint Supplier
• vertical-sides-paint-system: Vertical Sides Paint System
• flat-bottom-paint-supplier: Flat Bottom Paint Supplier
• flat-bottom-paint-system: Flat Bottom Paint System

dry-docking:  Dry-docking

• af-paint-applied: Antifouling paint applied
• vertical-sides-paint-supplier-2: Vertical Sides Paint Supplier
• vertical-sides-paint-system-2: Vertical Sides Paint System
• flat-bottom-paint-supplier-2: Flat Bottom Paint Supplier
• flat-bottom-paint-system-2: Flat Bottom Paint System

hull-cleaning: Hull-cleaning

propeller-polish: Propeller-polish 

Beside the standard events and attributes listed above, each company can define its own custom events and attributes that will get custom handles.

Users

There are few things to be kept in mind when moving users between user groups using the /users endpoint.

• User group id is used to move a user to user group. User group ids are available in the endpoint

  /users/groups

• To remove a user from user group, the user group id should be given as 0. When users are removed from a user group they are given minimum access rights.

  {
    "active": true,
    "userGroupId": 0
  }

• Users that are in a user group but have customised settings cannot be moved between groups unless the custom settings are removed first in UI. These users are marked with:

  "userGroupCusomized": true

• Users cannot be moved to a user group that is marked as external.

  "externalUserGroup": true

• Users identified as external users cannot be moved between user groups using the API. These users are marked with:

  "externalUser": true

• Moving user to a user group with a lot of hidden fields (>100) can be expected to take up to minute to finalise. Number of hidden fields in a user group is given in the user groups endpoint

  "numberOfHiddenFields": 131