URL Versioning
Info |
---|
V1 is a fundamental method with the basic information needed from a person’s |
...
travel record. |
Info |
---|
Sample sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AIWS_CU_TRAVEL |
Name | Format | Mandatory | Example | APM XREF | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Interface | string |
| companyname_import | Adonis generated interface name | |||||||
ExternalPIN | string |
| AAA-9999999 | Automatically mapped with the Adonis PIN. | This is the UID/PIN of the seaman inside your company/organization. | ||||||
ExternalDocID | string |
| AAA-9999999 | Automatically mapped with the Adonis DOCID | This is the unique DOCID of the seaman’s competence inside your company/organization. | ||||||
ExternalDocType | string |
| 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 |
| 2022-14-03 | date when the travel document is valid | |||||||
DateTo | YYYY-MM-DD |
| 2027-14-02 | date until the travel document is valid | |||||||
DocumentNo | string |
| 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 |
| 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 | any comments |