Versions Compared

Version Old Version 11 New Version 12
Changes made by

Anabelle Fajanel

Anabelle Fajanel

Saved on

Key

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

...

Connection

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

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

 

Travel

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": "SHIPADMIN",
    "ExternalPin": "SA-898",
    "ExternalDocID": "DOC002",
    "ExternalDocType": "SEABOOK",
    "DateFrom": "2022-01-25",
    "DateTo": "2032-01-25",
    "DocumentNo": "SEA-352GF2",
    "IssuedWhere": "Oslo",
    "IssuedBy": "Maritime Institute of Oslo",
    "IssueCountry": "NO",
    "DocumentScanBase64": "",
    "DocumentFileName": "",
    "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.

ExternalDocID

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

AAA-9999999

Automatically mapped with the Adonis DOCID

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

ExternalDocType

string

Status
colourGreen
titleY

Status
colourBlue
titlev1

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

ExternalDocCode

string

 

Status
colourBlue
titleV1

SCAN

Identified in APM > Setup > General Codes > Enclosed Document > Enclosed Document Codes

Code to identify the enclosed document type in APM

DateFrom

YYYY-MM-DD

Status
colourBlue
titleY/N

Status
colourBlue
titlev1

2022-14-03

date when the travel document is valid

DateTo

YYYY-MM-DD

Status
colourBlue
titleY/N

Status
colourBlue
titlev1

2027-14-02

date until the travel document is valid

DocumentNo

string

Status
colourBlue
titleY/N

Status
colourBlue
titlev1

98736

travel document number

IssuedWhere

string

Status
colourBlue
titlev1

PHMANILA

Country where it was issued

IssuedBy

string

Status
colourBlue
titlev1

MARINA MANILA

Office location of the Maritime Industry

Issuecountry

2 letters

Status
colourBlue
titleY/N

Status
colourBlue
titlev1

PH

Country where the competence was issued

DocumentScanBase64

base64

Status
colourBlue
titlev1

Expand
titleURI Format only

"data:text/plain;base64,UkVDUlVJVEVSU0VSVklDRVMgQVVESVQgQ09ERVMgU0hPVUxEIEJFIFNUQVJUIFdJVEggMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCkpPQlNFRUtFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVCBXSVRIIDUwMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KDQpFTVBMT1lFUlNFUlZJQ0VTIENPREVTIFNIT1VMRCBTVEFSVCBXSVRIIDEwMDE6DQo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCglGb3Jnb3RfcGFzc3dvcmRfcmVxdWVzdCA9IDEwMDEsDQogICAgICAgIFVwZGF0ZV9wYXNzd29yZCwNCiAgICAgICAgTG9nZ2VkX2luLA0KICAgICAgICBMb2dnZWRfb3V0DQoJVXNlcl9hZGRlZCwNCiAgICAgICAgVXNlcl91cGRhdGVkLA0KICAgICAgICBVc2VyX3JlbW92ZWQsDQogICAgICAgIFVzZXJfYWN0aXZhdGVkLA0KICAgICAgICBVc2VyX2RlYWN0aXZhdGVkLA0KICAgICAgICBTZXR0aW5nc191cGRhdGVkLA0KCVNlbmROb3RpZmljYXRpb25zX2luc2VydGVkLA0KCUVtcGxveWVyX2FkZGVkLA0KICAgICAgICBFbXBsb3llcl91cGRhdGVkLA0KICAgICAgICBFbXBsb3llcl9yZW1vdmVkLA0KICAgICAgICBFbXBsb3llcl9hY3RpdmF0ZWQsDQogICAgICAgIEVtcGxveWVyX2RlYWN0aXZhdGVkLA0KCVByZWZlcmVuY2VzX0FkZGVkLA0KICAgICAgICBQcmVmZXJlbmNlc191cGRhdGVkLA0KICAgICAgICBQcmVmZXJlbmNlc19yZW1vdmVkLA0KCVR3b0ZBTG9naW5fQWRkZWQsDQoJVGlueVVSTF9VcGRhdGVkLA0KICAgICAgICBUaW55VVJMX0FkZGVkDQoJU2lnbmF0dXJlX1VwZGF0ZWQsDQoJU2lnbmF0dXJlX1JlbW92ZWQNCg0KDQpUQVNLTUFOQUdFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVEVEIA0KV0lUSCAxNTAxOg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KCVRhc2tSZXF1ZXN0X0FkZGVkID0gMTUwMQ0KCVRhc2tSZXF1ZXN0X1VwZGF0ZWQNCglUYXNrUmVxdWVzdF9VcGRhdGVk",

Scanned copy of the document

DocumentFileName

string

Status
colourBlue
titlev1

seamanbook.jpg

the filename of the scanned document

Comments

string

Status
colourBlue
titlev1

any comments