URL Versioning
| Info |
|---|
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_CU_COMPETENCE |
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 |
| FAM-SFBF | Identified in APM > Setup > General Codes > Competence > Competence Codes | Code to identify the type of competence / training or certificate | ||||||
DocumentNo | string |
| SWJXLYM732727 | Document / certificate number | |||||||
DateFrom | YYYY-MM-DD |
| 2022-08-16 | Date from the certificate is valid | |||||||
DateTo | YYYY-MM-DD | 2025-08-15 | Date the certificate is ending | ||||||||
ExpiryDate | YYYY-MM-DD |
| 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 | BERGENSFJORD | School, training center etc. who issued the competence | ||||||||
IssuePlace | string | BERGEN | Place of issue | ||||||||
ValidInCountry | 2 letters | NO | Country where the competence was issued | ||||||||
DocumentScanBase64 | base64 | Scanned copy of the document | |||||||||
DocumentFIleName | string | Eksamensbevis.pdf | the filename of the scanned document | ||||||||
Comments | string | any comments |