Dispute Update API

This endpoint facilitates the update change of a dispute transferred from SMART ODR to the respective ODR Institution.

This API endpoint is designed to handle update changes related to dispute resolution cases.

Endpoint

POST https://<apiserver>.smartodr.com/update

Versioning

The Dispute Update API is a versioned API. Updates are released quarterly.

• Initial Release:

  • Version 1.0.0

• Adding a New Feature:

  • Version 1.1.0

• Fixing a Bug:

  • Version 1.1.1

• Making a Backward-Incompatible Change:

  • Version 2.0.0

Authentication

All incoming requests from ODR Institutions will include a valid access token in the Authorization header. SMART ODR should validate this token to ensure the request is from the respective ODR Institutions.

Authorization: `Signature keyId="${unique_key_id}|${token}|RS256" algorithm="RS256" type="update" `

unique_key_id : Unique token generated by ODR Institutions from SMART ODR Portal
token : Signed JWT Token [RS256]

Token Payload

The payload of the JWT includes the following information:

• email: The primary email address of the user associated with the ODR Institution.
• phone: The primary phone number of the user associated with the ODR Institution.

Request Body Parameters

Field	Data Type	Description
disputeId	String	Unique identifier for the dispute.
disputetype	String	Type of dispute.
role	String	Role of the user putting an update (e.g., User, Administrator).
userName	String	User's name initiating the update.
update	String	Update of the dispute.

User Reference Table

Role	Description
MEDIATOR	Mediator
ARBITRATOR	Arbitrator
SYSADMIN	System Administrator
CASEMANAGER	Case Manager
PETITIONER	Petitioner
RESPONDENT	Respondent

Example:

{
    "dispute": {
        "disputeId": "MII-INV-2024-01-781096",
        "userName": "Bruce Wayne",
        "role": "mediator",
        "description": "test123",
        "disputetype": "conciliation",
        "update": "Date & Time of Conciliator Appointment"
    }
}

The dispute parameter contains the JSON string with information about the dispute, as described in the previous section.

Success Response

If the update is successful, the API returns a 200 OK status along with a JSON object containing relevant information.

Fields in the Response

Field	Data Type	Description
success	Boolean	Indicates whether the update was successful (true) or (false).
message	String	Update to the Dispute Id : {reference_id} received

Example:

{
  "success": true,
  "message": "Update to the Dispute 123456 received",
}

Error Response

Fields in the Response

Field	Data Type	Description
success	Boolean	Indicates whether the update was successful (true) or (false).
message	String	A detailed error message describing the issue.

{
  "success": false,
  "message": "Error message describing the issue"
}