Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

URL Versioning

...

V1 is a fundamental method with the basic information needed from a person’s competence record.

...

The new AUS service no longer requires the Authentication_Token. This means that calling GNL_API_AUTHENTICATION is no longer required.

Connection

Info

URL: http://yourcompanyyourdomain.com/AIWS_APPAUS/AdonisIntegrationWebServiceAdonisUploadService.svc/v1/AIWS_COMPETENCE

...

Name

...

Format

...

Mandatory

...

Example

...

APM XREF

...

Description

...

Interface

...

string

...

Status
colourGreen
titleY

...

companyname_import

...

Adonis generated interface name

...

ExternalPIN

...

string

...

Status
colourGreen
titleY

...

AAA-9999999

...

Automatically mapped with the Adonis PIN.

...

This is the UID/PIN of the seaman inside your company/organization.

...

ExternalDocID

...

string

...

Status
colourGreen
titleY

...

AAA-9999999

...

Automatically mapped with the Adonis DOCID

...

This is the unique DOCID of the seaman’s competence inside your company/organization.

...

ExternalDocType

...

string

...

Status
colourGreen
titleY

...

FAM-SFBF

...

Identified in APM > Setup > General Codes > Competence > Competence Codes

...

Code to identify the type of competence / training or certificate

...

DocumentNo

...

string

...

Status
colourGreen
titleY

...

SWJXLYM732727

...

Document / certificate number

...

DateFrom

...

YYYY-MM-DD

...

Status
colourGreen
titleY

...

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

...

Status
colourGreen
titleY

...

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

...

CU_Competence

The above URL is composed of yourdomain + AUS + AdonisUploadService.svc + Version + API method

APIKey must be included in the header

Adonis prepared the following versions depending on the company’s requirements.

Child pages (Children Display)
allChildrentrue

How to generate an API Key

...