Versions Compared

Key

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

...

Name

Format

Mandatory

Version

Example

APM XREF

Description

Interface

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

companyname_import

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

This is unique identifier and mandatory for each request.

ExternalPIN

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

AAA-9999999

Automatically mapped with the Adonis PIN.

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

FirstName

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

JOHN

MiddleName

string

Status
colourBlue
titlev1

DOE

LastName

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

SMITH

CallingName

string

Status
colourBlue
titlev1

JOE

SuffixName

string

Status
colourBlue
titlev1

JR / MBA

Initials

string

Status
colourBlue
titlev1

JDS

Title

string

Status
colourBlue
titlev1

Mr

Limited to Mr, Mrs, Miss, Ms, Dr, Capt

Gender

M,F,U,N

Status
colourGreen
titleY

Status
colourBlue
titlev1

M

Limited to M=Male; F=Female; U=Unknown; N=Non-binary,

ExternalMaritalStatus

string

Status
colourBlue
titlev1

MARRIED

Identified in APM > Setup > General Codes > Family > Marital Status Codes

Nationality

2 letters

Status
colourGreen
titleY

Status
colourBlue
titlev1

DK

2 letter country code

NativeLangauge

2 letters

Status
colourBlue
titlev1

FI (Finnish)

ISO 639 Set 1 (2 letter code)

BirthDate

YYYY-MM-DD

Status
colourBlue
titlev1

1974-12-25

PlaceOfBirth

string

Status
colourBlue
titlev1

AALBORG

City or town of birth

CountryOfBirth

2 letters

Status
colourBlue
titlev1

DK

2 letter country code

ExternalHairColor

string

Status
colourBlue
titlev1

LIGHT BLONDE

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

hair color

ExternalEyeColor

string

Status
colourBlue
titlev1

BLUE

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

eye color

Height

number in cm

Status
colourBlue
titlev1

174

in centimeters

Weight

number in kg

Status
colourBlue
titlev1

90

in kilogram

HomeAirport

3 letters

Status
colourBlue
titlev1

AAL

Identified in APM > Setup > General Codes > Travel > Airport

Or use the 3 letter IATA airport codes

IATA code of the closest airport for the seaman.

TravelTime

00:00

Status
colourBlue
titlev1

06:00

preferred 1st option travel time

HomeAirport2

string

Status
colourBlue
titlev1

BLL

Identified in APM > Setup > General Codes > Travel > Airport

Or use the 3 letter IATA airport codes

IATA code of the 2nd closest airport for the seaman.

TravelTime2

00:00

Status
colourBlue
titlev1

08:00

preferred 2nd option travel time

AddressLine1

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

16 Tinglykke

Address of the seaman

AddressLine2

string

Status
colourBlue
titlev1

AddressLine3

string

Status
colourBlue
titlev1

AddressCountry

2 letters

Status
colourBlue
titlev1

DK

2 letter country code

AddressPostcode

string

Status
colourBlue
titlev1

9210A

Postal code

AddressPlace

string

Status
colourBlue
titlev1

AALBORG

City

AddressState

string

Status
colourPurple
titlev2

New York

Country should be mandatory if AddressState ≠ NULL

Email

string

Status
colourBlue
titlev1

johnsmith@email.com

Mobile

number

Status
colourBlue
titlev1

80001234

Mobile number of the seaman

Telephone

number

Status
colourBlue
titlev1

80004321

Organization

int

Status
colourGreen
titleY

Status
colourBlue
titlev1

100000018

Identified in the APM > Organization Structure

Adonis generated NUMORGID

PersonalID

int

Status
colourPurple
titlev2

16108012345

(SSN) Personal Number

AlternativePIN

string

Status
colourPurple
titlev2

AAA-9999999

Alternative PIN

ExternalRank

string

Status
colourBlue
titlev1

CHENG

Seaman’s Rank

ExternalContractType

string

Status
colourBlue
titlev1

FULL

Seaman’s Contract Type

...