POST api/v1/banzaifieldservices/{PartnerId}/Notification
Insert a standalone Notification
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PartnerId |
The partner identifier: 1 = 'ePRICE' |
integer |
Required |
Body Parameters
Notification model
NotificationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| Channel | string |
None. |
|
| Type | string |
None. |
|
| Message | string |
None. |
|
| Viewed | boolean |
None. |
|
| Closed | boolean |
None. |
|
| OrderNumber | integer |
None. |
|
| UserId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": 1,
"startDate": "2025-12-08T16:57:06.0085308+01:00",
"endDate": "2025-12-08T16:57:06.0085308+01:00",
"channel": "sample string 4",
"type": "sample string 5",
"message": "sample string 6",
"viewed": true,
"closed": true,
"orderNumber": 9,
"userId": "cdca2218-db98-4ace-9c7b-66443944cf12"
}
text/plain
Sample:
{"id":1,"startDate":"2025-12-08T16:57:06.0085308+01:00","endDate":"2025-12-08T16:57:06.0085308+01:00","channel":"sample string 4","type":"sample string 5","message":"sample string 6","viewed":true,"closed":true,"orderNumber":9,"userId":"cdca2218-db98-4ace-9c7b-66443944cf12"}
application/xml, text/xml
Sample:
<NotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServicePlatform.BL.Models.Notification.Dto"> <Channel>sample string 4</Channel> <Closed>true</Closed> <EndDate>2025-12-08T16:57:06.0085308+01:00</EndDate> <Id>1</Id> <Message>sample string 6</Message> <OrderNumber>9</OrderNumber> <StartDate>2025-12-08T16:57:06.0085308+01:00</StartDate> <Type>sample string 5</Type> <UserId>cdca2218-db98-4ace-9c7b-66443944cf12</UserId> <Viewed>true</Viewed> </NotificationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/octet-stream
Sample:
{"Id":1,"StartDate":"2025-12-08T16:57:06.0085308+01:00","EndDate":"2025-12-08T16:57:06.0085308+01:00","Channel":"sample string 4","Type":"sample string 5","Message":"sample string 6","Viewed":true,"Closed":true,"OrderNumber":9,"UserId":"cdca2218-db98-4ace-9c7b-66443944cf12"}
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |