Introduction
Adonis Web Service is the WCF Windows Communication Foundation solution based on JSON standard response/request. It provides CU (create and update) operations and performs actions on Adonis Ecosystem entities.
Personal Details
Next of Kin Details
Sea Service Activities
Competences
Travel Records
Medical Records
APP Endpoints
Cross Reference Codes (XREF)
The XREF functionality in Adonis is designed to establish links between the Adonis lookup tables, such as General Codes and Organization Structure, and their corresponding codes used in external systems.
Interface Code: Each external system within Adonis is identified by an interface code. This code enables the association of a single standard code with multiple external systems.
XREF Code: the actual code used by the external system
How to add an xref Interface definition
Log into the Adonis Personnel Manager. Once logged in, navigate to the Setup ribbon tab > General Codes > Miscellaneous > Interfaces and proceed with the following steps:
On the ribbon, click New to make the dialogue appear:
![](https://rippleops.atlassian.net/wiki/download/attachments/4773806084/moodle_plugin_set_moodle_code.png?version=1&modificationDate=1689608298532&cacheVersion=1&api=v2)
Enter a Code (mandatory field), a unique alpha-numeric APM code.
In the Text field, indicate the name of an interface and its alternative name, if needed, in the Alternative field.
In the Sort field, define the order number of a record (where 0 means the first record in the list).
In the Is Passive field, specify whether the code is to be active or passive. Passive codes appear as disabled. Setting a code to Passive is recommended if it is no longer in use.
In the APP Modules field, select the Adonis Personal Portal module(s) where you want to use the code.
Click OK to proceed.
How to link a lookup table (competencies code) to the 3rd party lookup
Navigate to the Setup ribbon tab > General Codes > Competence > Competence Codes:
Select the competence affected and click Open on the toolbar.
Switch to the XREF tab and click the Append button. Clicking the command enables the fields to be filled out:
Interface. Select the interface from the drop-down list. If the interface is unavailable, you need to define the interface by following the instructions in How to add an xref interface above.
Xref Code. Enter a cross-reference value of the 3rd party system
Comment. Enter any comment you want to add.
![](https://rippleops.atlassian.net/wiki/download/attachments/4773806084/moodle_plugin_set_competence_code_assigned_xref.png?version=1&modificationDate=1689608298577&cacheVersion=1&api=v2)
When completed, click OK to apply the changes.
Waiting Room
Information that can’t be uploaded to the Adonis Database is placed in the waiting room, waiting for further action by the customer.
Click here for more details on how to access the waiting room from APM.
How to consume the Adonis API
Step by step guide on how to consume using Adonis API calls.
How to consume the Adonis API
Error Text and Solutions
Interfaces Error/Text and Solutions