Versions Compared

Key

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

...

Info

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

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
Code Block
{
  "request": {
    "Interface": "ANKAA",
    "ExternalPin": "88772",
    "ExternalActivityID": "ACT-11",
    "ExternalActivityCode": "ONB",
    "SignOn": "2024-03-25",
    "SignOffEstimated": "2024-04-25",
    "SignOff": "",
    "VesselIMO": "9865958",
    "ExternalPositionCode": "CHENG",
    "Comments": ""
  }
}

 

Fields Definition

...

Name

...

Format

...

Mandatory

...

Version

...

Example

...

APM XREF

...

Description

...

Interface

...

string

...

Status
colourGreen
titleY

...

Status
colourBlue
titlev1

...

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

...

Status
colourBlue
titlev1

...

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

...

Status
colourBlue
titlev1

...

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

...

Status
colourGreen
titleY

...

Status
colourBlue
titlev1

...

2022-08-17

...

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

...

SignOff

...

YYYY-MM-DD

...

Status
colourBlue
titlev1

...

2022-10-12

...

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

...

SignOffEstimated

...

YYYY-MM-DD

...

Status
colourBlue
titlev1

...

2022-10-01

...

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

...

VesselIMO

...

number

...

Status
colourGreen
titleY

...

Status
colourBlue
titlev1

...

8320573

...

Unique Vessel IMO

...

ExternalPositionCode

...

string

...

Status
colourBlue
titlev1

...

MAS

...

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

...

Rank / position of the seaman.

...

Comments

...

string

...

Status
colourBlue
titlev1

...

Adonis has developed various versions tailored to meet specific company needs.

Child pages (Children Display)
depth1
allChildrentrue
style
sortAndReverse
first0