URL Versioning
V1 is a fundamental method with the basic information needed from a person’s competence record.
Sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AIWS_COMPETENCE
Name | Format | Mandatory | Version | Example | APM XREF | Description |
|---|---|---|---|---|---|---|
Interface | string | Y | V1 | companyname_import | 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 | FAM-SFBF | Identified in APM > Setup > General Codes > Competence > Competence Codes | Code to identify the type of competence / training or certificate |
DocumentNo | string | Y | V1 | SWJXLYM732727 | Document / certificate number | |
DateFrom | YYYY-MM-DD | Y | V1 | 2022-08-16 | Date from the certificate is valid | |
DateTo | YYYY-MM-DD | V1 | 2025-08-15 | Date the certificate is ending | ||
ExpiryDate | YYYY-MM-DD | Y | V1 | 2025-08-15 | Date the certificate is expired. If DateTo is Not Null AND ExpiryDate is Null then copy the DateTo to ExpiryDate. | |
IssueBy | string | V1 | BERGENSFJORD | School, training center etc. who issued the competence | ||
IssuePlace | string | V1 | BERGEN | Place of issue | ||
ValidInCountry | 2 letters | V1 | NO | Country where the competence was issued | ||
DocumentScanBase64 | base64 | V1 | Scanned copy of the document | |||
DocumentFIleName | string | V1 | Eksamensbevis.pdf | the filename of the scanned document | ||
Comments | string | V1 | any comments |