URL Versioning
V1 is a fundamental method with the basic information needed from a person’s activities record.
sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AIWS_CU_ACTIVITIES
Name | Format | Mandatory | Example | APM XREF | Description |
|---|---|---|---|---|---|
Interface | string | Y | companyname_import | Adonis generated interface name | |
ExternalPIN | string | Y | AAA-9999999 | Automatically mapped with the Adonis PIN. | This is the UID/PIN of the seaman inside your company/organization. |
ExternalActivityID | string | Y | AAA-9999999 | Automatically mapped with the Adonis DOCID | This is the unique DOCID of the seaman’s competence inside your company/organization. |
ExternalActivityCode | string | Y | LEAVE | Identified in APM > Setup > General Codes > Activities > Activity Codes | The type of the Activity Code i.e. ONB, VAC, MAT, SICK etc… |
SignOn | YYYY-MM-DD | Y | 2022-08-17 | The start date of the sea service | |
SignOff | YYYY-MM-DD | 2022-10-12 | The end date of the sea service | ||
SignOffEstimated | YYYY-MM-DD | 2022-10-01 | The confirmed end date of the sea service | ||
Onboard | 1 letter | Y | Y=Onboard; N=Planned | ||
VesselIMO | number | Y | 8320573 | Unique Vessel IMO | |
ExternalPositionCode | string | MAS | Identified in APM > Setup > General Codes > Personal Details > Ranks | Rank / position of the seaman. | |
EmbarkationPort | string | ||||
DisembarkationPort | string | ||||
Comments | string | any comments |