Send Notification to ODIN
π Overviewβ
The SendNotificationToOdin API is used to send notifications or general messages to the Odin Diet and Dealer Terminal applications.
π Endpointβ
| Method | URL |
|---|---|
| POST | <protocol>://<host name>:<service port>/<service name>/<tenantid>/v1/sendNotificationToOdin |
Requestβ
The request consists of the following parameters:
π₯Request Parametersβ
| Parameter | Data Type | Mandatory / Optional | Description |
|---|---|---|---|
label | string | Mandatory | MSMQ Message Object label. Must contain the value "GENERAL". |
message | string | Mandatory | Message structure as defined in ebuzz_api-specification_All modes.pdf under General Message API. |
Example Requestβ
Headersβ
{
"Authorization": "Bearer eyBDyGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTUyMyIsIm5Ob2RlTGljZW5zZUV4cGlyeSI6IjE4OTM2MDkwMDAiLCJpYXQiOjE1NjM2MDI2Nzd9.oRVgIlN3K_m5AXh_K1M88exzBg96CYJEVo_LQ-YZ6Yd"
}
Request Bodyβ
{
"label": "GENERAL",
"message": "4|||SIDDIK,HO|1|test333|test1232223555|WEBADMIN|MODEM|||3"
}
Responseβ
The ResponseObject contains the following parameters in a JSON structure:
π§ͺ Response Parametersβ
| Parameter (Key) | Data Type | Description |
|---|---|---|
status | boolean | Indicates the status of the request. true if the response is successful, false if an error occurred. |
errorCode | string | Error code if any error occurred. |
errorString | string | Error description. |
Example Responseβ
{
"status": true,
"errorCode": "",
"errorString": "Notification sent successfully"
}