v1/AIWS_CU_Travel

The basic travel records of a seaman.

Fields Definition

Name	Format	Mandatory	Version	Example	APM XREF	Description

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 UID of the record
ExternalDocType	string	Y	v1	SEAMANBOOK	Identified in APM > Setup > General Codes > Travel Documents > Travel Document Codes	Code to identify the type of travel certificate
ExternalDocCode	string	Y	V1	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	Y/N	v1	2022-14-03	Identified in APM > Setup > General Codes > Travel Documents > Travel Document Codes Options to make mandatory for the following fields DateFrom, DateTo, DocumentNo and Issuecountry	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
Issuecountry	2 letters	Y/N	v1	PH		Country where the competence was issued. ISO 3166-1 Set A-2 (2 letter country code)
IssuedWhere	string		v1	MANILA		City or Location where the travel certificate was issued.
IssuedBy	string		v1	MARINA MANILA		Organization, Company or School where the travel doc was issued.
DocumentScanBase64	base64		v1	"data:text/plain;base64,UkVDUlVJVEVSU0VSVklDRVMgQVVESVQgQ09ERVMgU0hPVUxEIEJFIFNUQVJUIFdJVEggMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCkpPQlNFRUtFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVCBXSVRIIDUwMToNCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KDQpFTVBMT1lFUlNFUlZJQ0VTIENPREVTIFNIT1VMRCBTVEFSVCBXSVRIIDEwMDE6DQo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQoNCglGb3Jnb3RfcGFzc3dvcmRfcmVxdWVzdCA9IDEwMDEsDQogICAgICAgIFVwZGF0ZV9wYXNzd29yZCwNCiAgICAgICAgTG9nZ2VkX2luLA0KICAgICAgICBMb2dnZWRfb3V0DQoJVXNlcl9hZGRlZCwNCiAgICAgICAgVXNlcl91cGRhdGVkLA0KICAgICAgICBVc2VyX3JlbW92ZWQsDQogICAgICAgIFVzZXJfYWN0aXZhdGVkLA0KICAgICAgICBVc2VyX2RlYWN0aXZhdGVkLA0KICAgICAgICBTZXR0aW5nc191cGRhdGVkLA0KCVNlbmROb3RpZmljYXRpb25zX2luc2VydGVkLA0KCUVtcGxveWVyX2FkZGVkLA0KICAgICAgICBFbXBsb3llcl91cGRhdGVkLA0KICAgICAgICBFbXBsb3llcl9yZW1vdmVkLA0KICAgICAgICBFbXBsb3llcl9hY3RpdmF0ZWQsDQogICAgICAgIEVtcGxveWVyX2RlYWN0aXZhdGVkLA0KCVByZWZlcmVuY2VzX0FkZGVkLA0KICAgICAgICBQcmVmZXJlbmNlc191cGRhdGVkLA0KICAgICAgICBQcmVmZXJlbmNlc19yZW1vdmVkLA0KCVR3b0ZBTG9naW5fQWRkZWQsDQoJVGlueVVSTF9VcGRhdGVkLA0KICAgICAgICBUaW55VVJMX0FkZGVkDQoJU2lnbmF0dXJlX1VwZGF0ZWQsDQoJU2lnbmF0dXJlX1JlbW92ZWQNCg0KDQpUQVNLTUFOQUdFUlNFUlZJQ0VTIEFVRElUIENPREVTIFNIT1VMRCBCRSBTVEFSVEVEIA0KV0lUSCAxNTAxOg0KPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0NCg0KCVRhc2tSZXF1ZXN0X0FkZGVkID0gMTUwMQ0KCVRhc2tSZXF1ZXN0X1VwZGF0ZWQNCglUYXNrUmVxdWVzdF9VcGRhdGVk",		Scanned copy of the document. File types allowed: Pdf, Doc, DocX, Xls, XlsX, Png, Jpg
DocumentFileName	string		v1	seamanbook.jpg		the filename of the scanned document
Comments	string		v1			any comments

Example Value in JSON

{
  "request": {
    "Interface": "SHIPADMIN",
    "ExternalPin": "SA-898",
    "ExternalDocID": "DOC002",
    "ExternalDocType": "SEABOOK",
    "ExternalDocCode": "SCAN",    
    "DateFrom": "2022-01-25",
    "DateTo": "2032-01-25",
    "DocumentNo": "SEA-352GF2",
    "IssuedWhere": "Oslo",
    "IssuedBy": "Maritime Institute of Oslo",
    "IssueCountry": "NO",
    "DocumentScanBase64": "",
    "DocumentFileName": "",
    "Comments": ""
  }
}

Adonis HR Plug-ins User Documentation

v1/AIWS_CU_Travel

Fields Definition

Example Value in JSON

Related content