...
Name | Format | Mandatory | Version | Example | APM XREF | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Interface | string |
|
| companyname_import | Identified in APM > Setup > General Codes > Miscellaneous > Interfaces | Adonis generated interface name | ||||||||||||
ExternalPIN | string |
|
| AAA-9999999 | Automatically mapped with the Adonis PIN. | This is the UID/PIN of the seaman inside your company/organization. | ||||||||||||
ExternalActivityID | string |
|
| AAA-9999999 | Automatically mapped with the Adonis DOCID | This is the unique DOCID of the seaman’s competence inside your company/organization. | ||||||||||||
ExternalActivityCode | string |
|
| LEAVE | Identified in APM > Setup > General Codes > Activities > Activity Codes | The type of the Activity Code i.e. ONB, VAC, MAT, SICK etc… | ||||||||||||
ExternalPositionCode | string |
|
| MAS | Identified in APM > Setup > General Codes > Personal Details > Ranks | Rank / position of the seaman. | ||||||||||||
SignOn | YYYY-MM-DD |
|
| 2022-08-17 | The start date of the sea service. Date format YYYY-MM-DD | |||||||||||||
SignOffEstimated | YYYY-MM-DD |
| 2022-10-01 | The confirmed end date of the sea service. Date format YYYY-MM-DD | ||||||||||||||
SignOff | YYYY-MM-DD |
| 2022-10-12 | The end date of the sea service. Date format YYYY-MM-DD | ||||||||||||||
VesselIMO | number |
|
| 8320573 | Unique Vessel IMO | |||||||||||||
PlaceFrom | string |
| 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 |
| DEMAI (Mainz) | |||||||||||||||
EmbarkationReason | string |
| REGEMBR | Identified in APM > Setup > General Codes > Personal Details > Embarking/Disembarking Reasons | ||||||||||||||
DisembarkationReason | string |
| REGDISEMBR | Identified in APM > Setup > General Codes > Personal Details > Embarking/Disembarking Reasons | ||||||||||||||
Comments | string |
| any comments |
Sample Request in JSON
GNL_API_AUTHENTICATION - To get the Authentication_Token
| Code Block |
|---|
//ONLY VIA HTTPS.
{
"credentials": {
"Login": "", //paste the username here
"Password": "", //paste the password here
"LifeTime": 18000
}
} |
AUS_CU_ActivitiesRotationLink
| Code Block |
|---|
{
"request": {
"Interface": "COMPANY_NAME",
"ExternalPin": "XX1234",
"ExternalActivityID": "AA-1001",
"ExternalActivityCode": "ONB",
"ExternalPositionCode": "BRKP",
"SignOn": "2024-03-15",
"SignOffEstimated": "2024-03-25",
"SignOff": "",
"VesselIMO": "9865958",
"PlaceFrom": "DELAE",
"PlaceTo": "DEMAI",
"EmbarkationReason": "REGEMBR",
"DisembarkationReason": "REGDISEMBR",
"Comments": "",
"Authentication_Token": "" //Paste the generated Auth Token hereIBXXXXgXLBwMXXXXIj09XWFKQ0JGUVVzV09XXXX3QV9DZU8zOT1dYUpXXXXRVXNXT19YSXdBX0XXXXM5"
}
} |