URL Versioning
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.
sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v2/AIWS_CU_NOK
Name | Format | Mandatory | Version | Example | APM XREF | Description |
---|---|---|---|---|---|---|
Interface | string | Y | V1 | companyname_import | Adonis generated interface name | |
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 | 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 | V1 | DK | 2 letter country code | ||
AddressPostcode | number | V1 | 9210 | Postal Code | ||
AddressPlace | string | V1 | AALBORG | City | ||
AddressState | string | V2 | New York | Country should be mandatory if AddressState ≠ NULL | ||
string | V1 | janesmith@email.com | ||||
Mobile | number | V1 | 80005678 | |||
Telephone | number | V1 | 80004321 |