Versions Compared

Version Old Version 1 New Version 2
Changes made by

Anabelle Fajanel

Anabelle Fajanel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Example Value in JSON

Expand
titlePlease expand
Code Block
{
  "request": {
    "Interface": "ANKAA",
    "ExternalPin": "ANKAA123457",
    "ExternalActivityID": "AACT-0008",
    "ExternalActivityCode": "OB",
    "ExternalPositionCode": "DC",
    "SignOn": "2024-01-25",
    "SignOff": "2024-09-29",
    "VesselName": "ABC Vessel",
    "VesselGRT": "9672",
    "VesselType": "Passenger Ship",
    "Country": "IN",
    "CrewID": "C233D",
    "PlaceFrom": "THLAS",
    "PlaceTo": "JPKSO",
    "Comments": ""
  }
}

Fields Definition

Name

Format

Mandatory

Example

APM XREF

Description

Interface

string

Status
colourGreen
titleY

companyname_import

Identified in APM > Setup > General Codes > Miscellaneous > Interfaces

Adonis generated interface name

ExternalPIN

string

Status
colourGreen
titleY

AAA-9999999

It is automatically mapped with the Adonis PIN.

This is the UID/PIN of the seaman inside your company/organization.

ExternalActivityID

string

Status
colourGreen
titleY

AAA-9999999

Automatically mapped with the Adonis DOCID

This is the unique DOCID of the seaman’s competence inside your company/organization.

ExternalActivityCode

string

Status
colourGreen
titleY

LEAVE

Identified in APM > Setup > General Codes > Activities > Activity Codes

The type of the Activity Code i.e. ONB, VAC, MAT, SICK etc…

ExternalPositionCode

string

Status
colourGreen
titleY

MAS

Identified in APM > Setup > General Codes > Personal Details > Ranks

Rank / position of the seaman.

SignOn

YYYY-MM-DD

Status
colourGreen
titleY

2022-08-17

The start date of the sea service. Date format YYYY-MM-DD

SignOff

YYYY-MM-DD

2022-10-12

The end date of the sea service. Date format YYYY-MM-DD

VesselName

string

ABC Greenstar

Free input text

VesselGRT

Numeric

9233

Gross register tonnage.

VesselType

string

Container Ship

Type of vessel

Country

string

IN

2 char code

CrewID

string

C233D

Limited to 5 alphanumeric characters

PlaceFrom

string

THLAS

It can be Airport (3 char code), Port (5 char code), City, or free input text

PlaceTo

string

JPKSO

It can be Airport (3 char code), Port (5 char code), Cities, or free input text

Comments

string

Free input text

...