Versions Compared

Version Old Version 2 New Version Current
Changes made by

Anabelle Fajanel

Anabelle Fajanel

Saved on

Key

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

...

Name

Format

Mandatory

Example

APM XREF

Description

Interface

string

Status
colourGreen
titleY

companyname_import

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

This is unique identifier and mandatory for each request.

ExternalPIN

string

Status
colourGreen
titleY

AAA-9999999

Automatically mapped with the Adonis PIN.

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

FirstName

string

Status
colourGreen
titleY

JOHN

MiddleName

string

DOE

LastName

string

Status
colourGreen
titleY

SMITH

CallingName

string

JOE

SuffixName

string

JR / MBA

Initials

string

JDS

Title

string

Mr

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

Gender

M,F,U,N

M

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

ExternalMaritalStatus

string

MARRIED

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

Nationality

2 letters

Status
colourGreen
titleY

DK

ISO 3166-1 Set A-2 (2 letter country code)

NativeLangauge

2 letters

FI (Finnish)

ISO 639 Set 1 (2 letter code)

BirthDate

YYYY-MM-DD

1974-12-25

PlaceOfBirth

string

AALBORG

City or town of birth

CountryOfBirth

2 letters

DK

ISO 3166-1 Set A-2 (2 letter country code)

ExternalHairColor

string

LIGHT BLONDE

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

hair color

ExternalEyeColor

string

BLUE

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

eye color

Height

number in cm

174

in centimeters

Weight

number in kg

90

in kilogram

HomeAirport

3 letters

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

06:00

preferred 1st option travel time

HomeAirport2

string

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

08:00

preferred 2nd option travel time

AddressLine1

string

Status
colourGreen
titleY

16 Tinglykke

Address of the seaman

AddressLine2

string

AddressLine3

string

AddressCountry

2 letters

Status
colourGreen
titleY

if AddressState ≠ NULL

DK

ISO 3166-1 Set A-2 (2 letter country code)

AddressPostcode

string

9210A

Postal code

AddressPlace

string

AALBORG

City

AddressState

string

New York

Country should be AddressCountry is mandatory if AddressState ≠ NULL

Email

string

johnsmith@email.com

Mobile

number

80001234

Mobile number of the seaman

Telephone

number

80004321

Organization

int

Status
colourGreen
titleY

100000018

Identified in the APM > Organization Structure

Adonis generated NUMORGID

PersonalID

int

16108012345

(SSN) Personal Number

AlternativePIN

string

AAA-9999999

Alternative PIN

ExternalRank

string

CHENG

Seaman’s Rank

ExternalContractType

string

FULL

Seaman’s Contract Type

Example Value in JSON

Expand
titlePlease expand
Code Block
{
  "request": {
    "Interface": "SHIPADMIN",
    "ExternalPin": "SA-123457",
    "FirstName": "Elvis",
    "MiddleName": "",
    "LastName": "Prestly",
    "CallingName": "Elv",
    "SuffixName": "",
    "Initials": "",
    "Title": "Mr",
    "Gender": "U",
    "Nationality": "UA",
    "NativeLangauge": "ES",
    "BirthDate": "2001-01-25",
    "PlaceOfBirth": "London",
    "CountryOfBirth": "ES",
    "ExternalHairColor": "BLACK",
    "ExternalEyeColor": "HAZEL",
    "Height": 190,
    "Weight": 85,
    "HomeAirport": "ABI",
    "TravelTime": "1200",
    "HomeAirport2": "",
    "TravelTime2": "",
    "ExternalMaritalStatus": "1",
    "ExternalRank": "DC",
    "ExternalContractType": "PE",
    "AddressLine1": "909-1/2 E 49th St",
    "AddressLine2": "",
    "AddressLine3": "",
    "AddressCountry": "US",
    "AddressPostcode": "90011",
    "AddressPlace": "Los Angeles",
    "AddressState": "California",
    "Email": "elvis@email.com",
    "Mobile": "(323) 238-0616",
    "Telephone": "",
    "Organization": "SHIPADMIN-001",
    "PersonalID": "PID123",
    "AlternativePIN": "APIN123"
  }
}