Versions Compared

Key

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

URL Versioning

Info

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

sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AIWS_CU_ACTIVITIES

 

Name

Format

Mandatory

Version

Example

APM XREF

Description

Interface

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

companyname_import

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

SignOff

YYYY-MM-DD

Status
colourBlue
titlev1

2022-10-12

The end date of the sea service

SignOffEstimated

YYYY-MM-DD

Status
colourBlue
titlev1

2022-10-01

The confirmed end date of the sea service

Onboard

1 letter

Status
colourBlue
titlev1

Y

Y=Onboard; N=Planned

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.

EmbarkationPort

string

Status
colourBlue
titlev1

DisembarkationPort

string

Status
colourBlue
titlev1

Comments

string

Status
colourBlue
titlev1

any comments