Skip to end of banner
Go to start of banner

v1/AIWS_CU_NOK

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 3 Current »

Basic Information of the seaman’s next of kin.  

Fields Definition

Name

Format

Mandatory

Version

Example

APM XREF

Description

Interface

string

Y

V1

companyname_import

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

This is the unique identifier and is mandatory for each request.

ExternalPIN

string

Y

V1

AAA-9999999

Automatically mapped with the Adonis PIN.

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

ExternalNOKID

string

V1

AAA-9999999

Automatically mapped with the Adonis NOKid

This is the unique NOKID of the seaman inside your company/organization.

FirstName

string

Y

V1

JANE

MiddleName

string

V1

NILSEN

LastName

string

Y

V1

SMITH

Gender

M,F,U,N

Y

V1

F

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

ExternalRelation

string

Y

V1

SPOUSE

Identified in APM > Setup > General Codes > Family > Relationship Codes

The relationship to the next of kin.

Nationality

2 letters

V1

NO

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

BirthDate

YYYY-MM-DD

V1

1979-11-29

PlaceOfBirth

string

V1

BERGEN

City or town of birth

AddressLine1

string

V1

16 Tinglykke

Address of the next of kin (NOK)

AddressLine2

string

V1

AddressLine3

string

V1

AddressCountry

2 letters

Y

If the AddressState ≠ NULL

V1 V2

DK

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

AddressPostcode

string

V1

9210A

Postal Code

AddressPlace

string

V1

AALBORG

City

AddressState

string

V2

New York

AddressCountry is mandatory if AddressState ≠ NULL

Email

string

V1

janesmith@email.com

Mobile

number

V1

80005678

Telephone

number

V1

80004321

Example Value in JSON

 Please expand
{
  "request": {
    "Interface": "SHIPADMIN",
    "ExternalPin": "SA-898",
    "ExternalNOKID": "",
    "ExternalRelation": "1",
    "FirstName": "Priscilla",
    "MiddleName": "",
    "LastName": "Prestly",
    "Gender": "F",
    "Nationality": "DE",
    "BirthDate": "1960-04-25",
    "PlaceOfBirth": "Aalborg",
    "AddressLine1": "17 Havregata",
    "AddressLine2": "",
    "AddressLine3": "",
    "AddressCountry": "DE",
    "AddressPostcode": "2332",
    "AddressPlace": "",
    "Email": "p@email.com",
    "Mobile": "7364-233",
    "Telephone": "7364-200"
  }
}
  • No labels