Basic Principles

Once the access credentials have been transmitted and the API has been activated for the term of the agreement, new OAIDs can be created and existing ones can be managed.

Endpoints in v2 are divided into the following 3 groups of services: OAID, Customer Site, and Relation & Partner.

OAID

The OAID service endpoints provide functionality for creating and updating OAIDs.

Create and Confirm

An OAID can be generated using the API call for creation. With the subsequent confirmation, the receipt of the OAID is acknowledged by the client, and it is enabled for further use.

Creation and Confirmation

When the OAID is created, it is assigned to the tenant.
The confirmation activates the OAID for further use!

Shown below is an example workflow for the creation and subsequent confirmation of one or more OAIDs. The implementation may differ from this process in detail.

How to Confirm OAID

OAID confirmation is handled automatically when calling either the "Assign/Create Site" or the "Set OAID Attributes" endpoint on an OAID.

Before implementation, the deployment and use of OAID should be clarified within the tenant (see blue section in the above diagram). Only the tenant's existing processes and systems, as well as the planned usage, are relevant here. Once these (internal) requirements have been clarified, the development of the API client can begin. The necessary interactions with the OAID register, especially REQUEST (create OAID) and CONFIRM (confirm OAID), are described in the API documentation.

Processing OAID

Processing of the OAID (blue task) refers to the internal storage of the OAID.
This does not refer to, for example, the creation of the customer site, which can take several days or months.

Management

Attributes of the OAID can be updated through the API. Depending on the specific attributes you'd like to update, they may be updated with one of the PATCH methods found within each of the API's services: OAID, Customer Site, and Relation & Partner. The implementation for this can be found in each of the corresponding v2 documentation pages.

Further usage is subject to OFAA standardizations and will be added here on an ongoing basis.

Customer Site and Relation

Customer Site endpoints can be called by PIPs to store location data for an OAID. In addition, the relation_name specifies the the unique relation between the PIP and ANO for the associated OAID. The relation name and its content must be submitted in the Relation & Partner endpoints. Below is a diagram of the process.

In the Use Cases section, we describe the workflow with an example.