URL Versioning
V1 is a fundamental method with the basic information needed from a person’s travel record.
sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AIWS_CU_TRAVEL
Name | Format | Mandatory | Version | Example | APM XREF | Description |
|---|---|---|---|---|---|---|
Interface | string | Y | V1 | companyname_import | Identified in APM > Setup > General Codes > Miscellaneous > Interfaces | Adonis generated interface name |
ExternalPIN | string | Y | V1 | AAA-9999999 | Automatically mapped with the Adonis PIN. | This is the UID/PIN of the seaman inside your company/organization. |
ExternalDocID | string | Y | V1 | AAA-9999999 | Automatically mapped with the Adonis DOCID | This is the unique DOCID of the seaman’s competence inside your company/organization. |
ExternalDocType | string | Y | V1 | 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 | Y/N | V1 | 2022-14-03 | date when the travel document is valid | |
DateTo | YYYY-MM-DD | Y/N | V1 | 2027-14-02 | date until the travel document is valid | |
DocumentNo | string | Y/N | V1 | 98736 | travel document number | |
IssuedWhere | string | V1 | PH | Country where it was issued | ||
IssuedBy | string | V1 | MARINA MANILA | Office location of the Maritime Industry | ||
Issuecountry | 2 letters | Y/N | V1 | PH | Country where the competence was issued | |
DocumentScanBase64 | base64 | V1 | Scanned copy of the document | |||
DocumentFileName | string | V1 | seamanbook.jpg | the filename of the scanned document | ||
Comments | string | V1 | any comments |