URL Versioning
...
V1 is a fundamental method with the basic information needed from a person’s record.
...
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/v1/AIWS_CU_PERSON |
| Info |
|---|
In the V2, AddressState, PersonalPIN, and AlternativePIN were added. If you think that you need the following parameters for your crewlist then you should use this version. sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v2/AIWS_CU_PERSON |
...
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.
...
FirstName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
JOHN
...
MiddleName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
DOE
...
LastName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
SMITH
...
CallingName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
JOE
...
SuffixName
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
JR / MBA
...
Initials
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
JDS
...
Title
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
Mr
...
Limited to Mr, Mrs, Miss, Ms, Dr, Capt
...
Gender
...
M,F,U,N
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
M
...
Limited to M=Male; F=Female; U=Unknown; N=Non-binary,
...
ExternalMaritalStatus
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
MARRIED
...
Identified in APM > Setup > General Codes > Family > Marital Status Codes
...
Nationality
...
2 letters
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
DK
...
2 letter country code
...
NativeLangauge
...
2 letters
...
| Status | ||||
|---|---|---|---|---|
|
...
FI (Finnish)
...
ISO 639 Set 1 (2 letter code)
...
BirthDate
...
YYYY-MM-DD
...
| Status | ||||
|---|---|---|---|---|
|
...
1974-12-25
...
PlaceOfBirth
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
AALBORG
...
City or town of birth
...
CountryOfBirth
...
2 letters
...
| Status | ||||
|---|---|---|---|---|
|
...
DK
...
2 letter country code
...
ExternalHairColor
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
LIGHT BLONDE
...
Identified in APM > Setup > General Codes > Miscellaneous > Colors
...
hair color
...
ExternalEyeColor
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
BLUE
...
Identified in APM > Setup > General Codes > Miscellaneous > Colors
...
eye color
...
Height
...
number in cm
...
| Status | ||||
|---|---|---|---|---|
|
...
174
...
in centimeters
...
Weight
...
number in kg
...
| Status | ||||
|---|---|---|---|---|
|
...
90
...
in kilogram
...
HomeAirport
...
3 letters
...
| Status | ||||
|---|---|---|---|---|
|
...
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 | ||||
|---|---|---|---|---|
|
...
06:00
...
preferred 1st option travel time
...
HomeAirport2
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
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 | ||||
|---|---|---|---|---|
|
...
08:00
...
preferred 2nd option travel time
...
AddressLine1
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
16 Tinglykke
...
Address of the seaman
...
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 | ||||
|---|---|---|---|---|
|
...
johnsmith@email.com
...
Mobile
...
number
...
| Status | ||||
|---|---|---|---|---|
|
...
80001234
...
Mobile number of the seaman
...
Telephone
...
number
...
| Status | ||||
|---|---|---|---|---|
|
...
80004321
...
Organization
...
int
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
100000018
...
Identified in the APM > Organization Structure
...
Adonis generated NUMORGID
...
PersonalID
...
int
...
| Status | ||||
|---|---|---|---|---|
|
...
16108012345
...
(SSN) Personal Number
...
AlternativePIN
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
AAA-9999999
...
Alternative PIN
...
ExternalRank
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
CHENG
...
Seaman’s Rank
...
ExternalContractType
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
FULL
...
The above URL is composed of yourdomain.com + 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
...