URL Versioning
...
V1 is a fundamental method with the basic information needed from a person’s activities 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_CU_ACTIVITIES |
...
Name
...
Format
...
Mandatory
...
Version
...
Example
...
APM XREF
...
Description
...
Interface
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
companyname_import
...
Adonis generated interface name
...
ExternalPIN
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
AAA-9999999
...
Automatically mapped with the Adonis PIN.
...
This is the UID/PIN of the seaman inside your company/organization.
...
ExternalActivityID
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
AAA-9999999
...
Automatically mapped with the Adonis DOCID
...
This is the unique DOCID of the seaman’s competence inside your company/organization.
...
ExternalActivityCode
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
LEAVE
...
Identified in APM > Setup > General Codes > Activities > Activity Codes
...
The type of the Activity Code i.e. ONB, VAC, MAT, SICK etc…
...
SignOn
...
YYYY-MM-DD
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
2022-08-17
...
The start date of the sea service
...
SignOff
...
YYYY-MM-DD
...
Status | ||||
---|---|---|---|---|
|
...
2022-10-12
...
The end date of the sea service
...
SignOffEstimated
...
YYYY-MM-DD
...
Status | ||||
---|---|---|---|---|
|
...
2022-10-01
...
The confirmed end date of the sea service
...
Onboard
...
1 letter
...
Status | ||||
---|---|---|---|---|
|
...
Y
...
Y=Onboard; N=Planned
...
VesselIMO
...
number
...
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
8320573
...
Unique Vessel IMO
...
ExternalPositionCode
...
string
...
Status | ||||
---|---|---|---|---|
|
...
MAS
...
Identified in APM > Setup > General Codes > Personal Details > Ranks
...
Rank / position of the seaman.
...
EmbarkationPort
...
string
...
Status | ||||
---|---|---|---|---|
|
...
DisembarkationPort
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Comments
...
string
...
Status | ||||
---|---|---|---|---|
|
...
Activities The above URL is composed of yourdomain + AUS + AdonisUploadService.svc + Version + API method APIKey must be included in the header |
Adonis has developed various versions tailored to meet specific company needs.
Child pages (Children Display) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
How to generate an API Key
...