Versions Compared

Version Old Version 4 New Version Current
Changes made by

Anabelle Fajanel

Anabelle Fajanel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

V1 is a fundamental method with the basic information needed from a person’s activities record.

sample URL request: http://domainyourdomain.com/AIWS_APPAUS/AdonisIntegrationWebServiceAdonisUploadService.svc/v1/AUSAIWS_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

Expand
titlePlease expand

{ "request": {
"Interface": "SHIPADMIN",
"ExternalPin": "SA-898",
"ExternalActivityID": "AACT-0009",
"ExternalActivityCode": "OB",
"ExternalPositionCode": "MAS",
"SignOn": "2024-01-25",
"SignOffEstimated": "2024-02-25",
"SignOff": "",
"ConfirmedSignOn": "N",
"VesselIMO": "9865958",
"PlaceFrom": "DELAE",
"PlaceTo": "DEMAI",
"EmbarkationPort": "REGEMBR",
"DisembarkationPort": "REGDISEMBR",
"Comments": ""
}
}

Name

Format

Mandatory

Version

Example

APM XREF

Description

Interface

string

Status
colourGreen
titleY

StatuscolourBluetitlev1

companyname_import

Identified in APM > Setup > General Codes > Miscellaneous > Interfaces

Adonis generated interface name

ExternalPIN

string

Status
colourGreen
titleY

status

colourBlue
titlev1

AAA-9999999

Automatically mapped with the Adonis PIN.

This is the UID/PIN of the seaman inside your company/organization.

ExternalActivityID

string

Status
colourGreen
titleY

StatuscolourBluetitlev1

AAA-9999999

Automatically mapped with the Adonis DOCID

This is the unique DOCID of the seaman’s competence inside your company/organization.

ExternalActivityCode

string

Status
colourGreen
titleY

StatuscolourBluetitlev1

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

Status
colourGreen
titleY

StatuscolourBluetitlev1YYYY-MM-DD

MAS

Identified in APM > Setup > General Codes > Personal Details > Ranks

Rank / position of the seaman.

SignOn

ConfirmedSignOn

Y/N

Status
colourGreen
titleY

Y

ConfirmedSignOn=Y will make the activity current if the SignOn <= CurrentDate.

Else the activity is planned.

This function will also trigger the Crew Change Module if this option is enabled

image-20241223-090824.pngImage Added

SignOn

YYYY-MM-DD

Status
colour

Blue

Green
title

v1

Y

2022-08-17

The start date of the sea service. Date format YYYY-MM-DD

SignOffEstimated

YYYY-MM-DD

StatuscolourBluetitlev1

2022-10-01

The confirmed end date of the sea service. Date format YYYY-MM-DD

SignOff

YYYY-MM-DD

StatuscolourBluetitlev1

2022-10-12

The end date of the sea service. Date format YYYY-MM-DD

VesselIMO

number

Status
colourGreen
titleY

StatuscolourBluetitlev1

8320573

Unique Vessel IMO

PlaceFrom

string

StatuscolourBluetitlev1

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

StatuscolourBluetitle

v1

DEMAI (Mainz)

EmbarkationReason

string

Status
colourBlue
titlev1

REGEMBR

Identified in APM > Setup > General Codes > Personal Details > Embarking/Disembarking Reasons

DisembarkationReason

string

StatuscolourBluetitle

v1

REGDISEMBR

Identified in APM > Setup > General Codes > Personal Details > Embarking/Disembarking Reasons

Comments

string

StatuscolourBluetitlev1

any comments

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

...