Versions Compared

Key

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

URL Versioning

...

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

...

The new AUS service no longer requires the Authentication_Token. This means that calling GNL_API_AUTHENTICATION is no longer required.

Connection

Info

URL: http://yourcompanyyourdomain.com/AIWS_APPAUS/AdonisIntegrationWebServiceAdonisUploadService.svc/v1/AIWS_CU_TRAVEL

 

...

Name

...

Format

...

Mandatory

...

Example

...

APM XREF

...

Description

...

Interface

...

string

...

Status
colourGreen
titleY

...

companyname_import

...

Adonis generated interface name

...

ExternalPIN

...

string

...

Status
colourGreen
titleY

...

AAA-9999999

...

Automatically mapped with the Adonis PIN.

...

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

...

ExternalDocID

...

string

...

Status
colourGreen
titleY

...

AAA-9999999

...

Automatically mapped with the Adonis DOCID

...

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

...

ExternalDocType

...

string

...

Status
colourGreen
titleY

...

SEAMANBOOK

...

Identified in APM > Setup > General Codes > Travel Documents > Travel Document Codes

Options to make mandatory for the following fields DateFrom, DateTo, DocumentNo and Issuecountry

...

Code to identify the type of travel certificate

...

DateFrom

...

YYYY-MM-DD

...

Status
colourBlue
titleY/N

...

2022-14-03

...

date when the travel document is valid

...

DateTo

...

YYYY-MM-DD

...

Status
colourBlue
titleY/N

...

2027-14-02

...

date until the travel document is valid

...

DocumentNo

...

string

...

Status
colourBlue
titleY/N

...

98736

...

travel document number

...

IssuedWhere

...

string

...

PH

...

Country where it was issued

...

IssuedBy

...

string

...

MARINA MANILA

...

Office location of the Maritime Industry

...

Issuecountry

...

2 letters

...

Status
colourBlue
titleY/N

...

PH

...

Country where the competence was issued

...

DocumentScanBase64

...

base64

...

Scanned copy of the document

...

DocumentFileName

...

string

...

seamanbook.jpg

...

the filename of the scanned document

...

Comments

...

string

...

Travel

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

APIKey must be included in the header

Adonis prepared the following versions depending on the company’s requirements.

Child pages (Children Display)
allChildrentrue

How to generate an API Key

...