Binding
This section describes a concrete communication binding (e.g., HTTPS, file transfer, WebSocket). All content in this section is non-normative and provided as an example implementation.
Concrete Specification
Prerequisites
This protocol uses HTTPS (TLS 1.2 or higher) and communicates via RESTful HTTP request/response.
Endpoints: HTTP methods (GET, POST, PUT, DELETE) are used against specified URIs.
Data Format: Request and response bodies use JSON format.
Authentication and Authorization: OAuth 2.0-based token authentication is used.
Security Requirements: TLS 1.2 or higher is required to ensure encrypted communication.
Field Definitions
For each field used in this binding, the following information is provided:
Field Name: Name used within this binding
Type: Data type (e.g., integer, string)
Requirement: Usage condition of the field
R = Required
C = Conditional
O = Optional
Request: Used in request messages
Response: Used in response messages
Description: Meaning and usage of the field
Header Field Definitions
x-notifier-api-key
String
R
✔
Specifies the API key issued per client application. ODS-specific field.
Authorization
String
R
✔
Specifies the access token. Example: Bearer .
Content-Type
String
R
✔
✔
Specifies the request format.
User-Agent
String
R
✔
Specifies the client user agent.
Accept-Language
String
O
✔
Specifies the client’s preferred language.
X-TrackingID
String
R
✔
✔
Specifies a unique ID used for request tracing. ODS-specific field.
Content-Security-Policy
String
R
✔
Specifies content loading and execution policies and controls allowed script and resource origins.
X-Content-Type-Options
String
R
✔
Prevents MIME-type sniffing by browsers and enforces the declared Content-Type.
Strict-Transport-Security
String
R
✔
Enforces HTTPS connections for a specified period and prevents downgrade to HTTP.
Cache-Control
String
R
✔
Specifies cache control mechanisms.
ETag
String
C
✔
Specifies a resource version identifier. Mandatory in responses to GET requests.
Last-Modified
String
C
✔
Specifies the last modified date and time of the resource. Mandatory in responses to GET requests.
Payload Field Definitions
Since the Request and Response fields differ for each function of this protocol, refer to the API Specification.
Functional Description
For detailed implementations such as Sent by, Resulting state(s), Request, Response, Examples, Error lists, and API-specific field definitions, refer to the API Specification.
Notification Destination List
Register / Retrieve / Update / Delete Notification Destination List
Performs operations related to notification destination lists required when a Data Provider notifies Data Consumers.
(Reference URL)
Notification Management
Register / Retrieve / Update / Delete Notifications
Performs operations related to notification content issued by Data Providers.
(Reference URL)
Notification Management
Update Notification Confirmation Status
Allows a Data Consumer to update the confirmation status of a notification.
(Reference URL)
Notification Management
Update Data Receipt Status
Allows a Data Consumer to update the receipt status of data.
(Reference URL)
Sequence Diagrams
Notification Destination List Create / Update / Retrieve / Delete
Notification Register / Update / Retrieve / Delete
Notification Review and Confirmation Status Update
Data Receipt and Receipt Status Update
Last updated