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