AUS_CU_ActivitiesRotationLink

Connection

URL: http://yourdomain.com/AUS/AdonisUploadService.svc/v1/AIWS_CU_ActivitiesRotationLink

The above URL is composed of yourdomain + AUS + AdonisUploadService.svc + Version + API method

APIKey must be included in the header

Example Value in JSON

Please expand

{
"request": {
"Interface": "SHIPADMIN",
"ExternalPin": "SA-898",
"ExternalActivityID": "AACT-0009",
"ExternalActivityCode": "OB",

"ExternalPositionCode": "MAS",
"SignOn": "2024-01-25",
"SignOffEstimated": "2024-02-25",
"SignOff": "",
"VesselIMO": "9865958",

"PlaceFrom": "DELAE",
"PlaceTo": "DEMAI",
"EmbarkationPort": "REGEMBR",
"DisembarkationPort": "REGDISEMBR",
"Comments": ""
}
}

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…
ExternalPositionCode	string	Y	V1	MAS	Identified in APM > Setup > General Codes > Personal Details > Ranks	Rank / position of the seaman.
SignOn	YYYY-MM-DD	Y	V1	2022-08-17		The start date of the sea service. Date format YYYY-MM-DD
SignOffEstimated	YYYY-MM-DD		V1	2022-10-01		The confirmed end date of the sea service. Date format YYYY-MM-DD
SignOff	YYYY-MM-DD		V1	2022-10-12		The end date of the sea service. Date format YYYY-MM-DD
VesselIMO	number	Y	V1	8320573		Unique Vessel IMO
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	REGDISEMBR	Identified in APM > Setup > General Codes > Personal Details > Embarking/Disembarking Reasons
Comments	string		V1			any comments

Sample Request in JSON

GNL_API_AUTHENTICATION - To get the Authentication_Token

//ONLY VIA HTTPS.
{
  "credentials": {
    "Login": "", //paste the username here
    "Password": "", //paste the password here
    "LifeTime": 18000
  }
}

AUS_CU_ActivitiesRotationLink

{
  "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": "IBXXXXgXLBwMXXXXIj09XWFKQ0JGUVVzV09XXXX3QV9DZU8zOT1dYUpXXXXRVXNXT19YSXdBX0XXXXM5" 
  }
}