URL Versioning
V1 is a fundamental method with the basic information needed from a person’s activities record.
sample URL request: http://domain.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AUS_CU_ActivitiesRotationLink
Name | Format | Mandatory | Version | Example | APM XREF | Description |
|---|---|---|---|---|---|---|
Interface | string | Y | V1 | companyname_import | Identified in APM > Setup > General Codes > Miscellaneous > Interfaces | 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. |
ExternalActivityID | string | Y | V1 | 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 | V1 | 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 | V1 | 2022-08-17 | The start date of the sea service | |
SignOff | YYYY-MM-DD | V1 | 2022-10-12 | The end date of the sea service | ||
SignOffEstimated | YYYY-MM-DD | V1 | 2022-10-01 | The confirmed end date of the sea service | ||
VesselIMO | number | Y | V1 | 8320573 | Unique Vessel IMO | |
ExternalPositionCode | string | V1 | MAS | Identified in APM > Setup > General Codes > Personal Details > Ranks | Rank / position of the seaman. | |
PlaceFrom | string | V1 | DELAE (Lagerdorf) | The first two letters code a country by the table defined in ISO 3166-1 alpha-2. The three remaining characters code a location within that country. | ||
PlaceTo | string | V1 | DEMAI (Mainz) | |||
EmbarkationReason | string | V1 | REGEMBR | Identified in APM > Setup > General Codes > Personal Details > Embarking/Disembarking Reasons | ||
DisembarkationReason | string | V1 | EOC | Identified in APM > Setup > General Codes > Personal Details > Ranks | ||
Comments | string | V1 | any comments |