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
...
Version
...
Example
...
APM XREF
...
Description
...
Interface
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
companyname_import
...
Identified in APM > Setup > General Codes > Miscellaneous > Interfaces
...
Adonis generated interface name
...
ExternalPIN
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
AAA-9999999
...
Automatically mapped with the Adonis PIN.
...
This is the UID/PIN of the seaman inside your company/organization.
...
ExternalDocID
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
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 | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
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 | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
2022-14-03
...
date when the travel document is valid
...
DateTo
...
YYYY-MM-DD
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
2027-14-02
...
date until the travel document is valid
...
DocumentNo
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
98736
...
travel document number
...
IssuedWhere
...
string
...
Status | ||||
---|---|---|---|---|
|
...
PH
...
Country where it was issued
...
IssuedBy
...
string
...
Status | ||||
---|---|---|---|---|
|
...
MARINA MANILA
...
Office location of the Maritime Industry
...
Issuecountry
...
2 letters
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
PH
...
Country where the competence was issued
...
DocumentScanBase64
...
base64
...
Status | ||||
---|---|---|---|---|
|
...
Expand | ||
---|---|---|
| ||
"data:text/plain;base64,UkVDUlVJVEVSU0VSVklDRVMgQVVESVQgQ09ERVMgU0hPVUxEIEJFIFNUQVJUIFdJVEggMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCkpPQlNFRUtFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVCBXSVRIIDUwMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KDQpFTVBMT1lFUlNFUlZJQ0VTIENPREVTIFNIT1VMRCBTVEFSVCBXSVRIIDEwMDE6DQo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCglGb3Jnb3RfcGFzc3dvcmRfcmVxdWVzdCA9IDEwMDEsDQogICAgICAgIFVwZGF0ZV9wYXNzd29yZCwNCiAgICAgICAgTG9nZ2VkX2luLA0KICAgICAgICBMb2dnZWRfb3V0DQoJVXNlcl9hZGRlZCwNCiAgICAgICAgVXNlcl91cGRhdGVkLA0KICAgICAgICBVc2VyX3JlbW92ZWQsDQogICAgICAgIFVzZXJfYWN0aXZhdGVkLA0KICAgICAgICBVc2VyX2RlYWN0aXZhdGVkLA0KICAgICAgICBTZXR0aW5nc191cGRhdGVkLA0KCVNlbmROb3RpZmljYXRpb25zX2luc2VydGVkLA0KCUVtcGxveWVyX2FkZGVkLA0KICAgICAgICBFbXBsb3llcl91cGRhdGVkLA0KICAgICAgICBFbXBsb3llcl9yZW1vdmVkLA0KICAgICAgICBFbXBsb3llcl9hY3RpdmF0ZWQsDQogICAgICAgIEVtcGxveWVyX2RlYWN0aXZhdGVkLA0KCVByZWZlcmVuY2VzX0FkZGVkLA0KICAgICAgICBQcmVmZXJlbmNlc191cGRhdGVkLA0KICAgICAgICBQcmVmZXJlbmNlc19yZW1vdmVkLA0KCVR3b0ZBTG9naW5fQWRkZWQsDQoJVGlueVVSTF9VcGRhdGVkLA0KICAgICAgICBUaW55VVJMX0FkZGVkDQoJU2lnbmF0dXJlX1VwZGF0ZWQsDQoJU2lnbmF0dXJlX1JlbW92ZWQNCg0KDQpUQVNLTUFOQUdFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVEVEIA0KV0lUSCAxNTAxOg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KCVRhc2tSZXF1ZXN0X0FkZGVkID0gMTUwMQ0KCVRhc2tSZXF1ZXN0X1VwZGF0ZWQNCglUYXNrUmVxdWVzdF9VcGRhdGVk", |
...
Scanned copy of the document
...
DocumentFileName
...
string
...
Status | ||||
---|---|---|---|---|
|
...
seamanbook.jpg
...
the filename of the scanned document
...
Comments
...
string
...
Status | ||||
---|---|---|---|---|
|
...
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) | ||
---|---|---|
|
How to generate an API Key
...