URL Versioning
| Info |
|---|
V1 is a fundamental method with the basic information needed from a person’s next of kin record. sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AIWS_CU_NOK |
...
In the V2, AddressState was added. If you think that you need this parameter for your crewlist then you should use this version.
...
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://yourcompanyyourdomain.com/AIWS_APPAUS/AdonisIntegrationWebServiceAdonisUploadService.svc/v2v1/AIWS_CU_NOK |
...
Name
...
Format
...
Mandatory
...
Version
...
Example
...
APM XREF
...
Description
...
Interface
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
companyname_import
...
Identified in APM > Setup > General Codes > Miscellaneous > Interfaces
...
This is unique identifier and mandatory for each request.
...
ExternalPIN
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
AAA-9999999
...
Automatically mapped with the Adonis PIN.
...
This is the UID/PIN of the seaman inside your company/organization.
...
ExternalNOKID
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
AAA-9999999
...
Automatically mapped with the Adonis NOKid
...
This is the unique NOKID of the seaman inside your company/organization.
...
FirstName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
JANE
...
MiddleName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
NILSEN
...
LastName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
SMITH
...
Gender
...
M,F,U,N
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
F
...
Limited to M=Male; F=Female; N=Non-binary, U=Unknown.
...
ExternalRelation
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
SPOUSE
...
Identified in APM > Setup > General Codes > Family > Relationship Codes
...
The relationship to the next of kin.
...
Nationality
...
2 letters
...
| Status | ||||
|---|---|---|---|---|
|
...
NO
...
2 letter country code
...
BirthDate
...
YYYY-MM-DD
...
| Status | ||||
|---|---|---|---|---|
|
...
1979-11-29
...
PlaceOfBirth
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
BERGEN
...
City or town of birth
...
AddressLine1
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
16 Tinglykke
...
Address of the next of kin (nok)
...
AddressLine2
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
AddressLine3
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
AddressCountry
...
2 letters
...
| Status | ||||
|---|---|---|---|---|
|
...
DK
...
2 letter country code
...
AddressPostcode
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
9210A
...
Postal Code
...
AddressPlace
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
AALBORG
...
City
...
AddressState
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
New York
...
Country should be mandatory if AddressState ≠ NULL
...
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
janesmith@email.com
...
Mobile
...
number
...
| Status | ||||
|---|---|---|---|---|
|
...
80005678
...
Telephone
...
number
...
| Status | ||||
|---|---|---|---|---|
|
...
The above URL is composed of yourdomain + AUS + AdonisUploadService.svc + Version + API method APIKey must be included in the header |
Adonis prepared the following versions depending on the company’s requirements.
| Child pages (Children Display) | ||
|---|---|---|
|
How to generate an API Key
...