Versions Compared

Version Old Version 13 New Version 14
Changes made by

Anabelle Fajanel

Anabelle Fajanel

Saved on

Key

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

The new AUS service no longer requires the Authentication_Token. This means that calling GNL_API_AUTHENTICATION is no longer required.

Connection

Info

URL: http://yourdomain.com/AUS/AdonisUploadService.svc/v1/AIWS_CU_NOK

The above URL is composed of yourdomain + AUS + AdonisUploadService.svc + Version + API method

APIKey must be included in the header

Example Value in JSON

Expand
titlePlease expand
Code Block
{
  "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"
  }
}

 

Fields Definition

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.

ExternalNOKID

string

Status
colourBlue
titleV1

AAA-9999999

Automatically mapped with the Adonis NOKid

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

FirstName

string

Status
colourGreen
titleY

Status
colourBlue
titleV1

JANE

MiddleName

string

Status
colourBlue
titleV1

NILSEN

LastName

string

Status
colourGreen
titleY

Status
colourBlue
titleV1

SMITH

Gender

M,F,U,N

Status
colourGreen
titleY

Status
colourBlue
titleV1

F

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

ExternalRelation

string

Status
colourGreen
titleY

Status
colourBlue
titleV1

SPOUSE

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

The relationship to the next of kin.

Nationality

2 letters

Status
colourBlue
titleV1

NO

2 letter country code

BirthDate

YYYY-MM-DD

Status
colourBlue
titleV1

1979-11-29

PlaceOfBirth

string

Status
colourBlue
titleV1

BERGEN

City or town of birth

AddressLine1

string

Status
colourBlue
titleV1

16 Tinglykke

Address of the next of kin (nok)

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

janesmith@email.com

Mobile

number

Status
colourBlue
titleV1

80005678

Telephone

number

Status
colourBlue
titleV1

80004321