POST api/v1/banzaifieldservices/{PartnerId}/Appointment/{AppointmentId}/Notification

Insert a Notification linked to appointment

Request Information

URI Parameters

Name	Description	Type	Additional information
PartnerId	The partner identifier: 1 = 'ePRICE'	integer	Required
AppointmentId	Order number	integer	Required

Body Parameters

Notification model

NotificationRequest

Name	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-10-31T14:02:06.6985552+01:00",
  "endDate": "2025-10-31T14:02:06.6985552+01:00",
  "channel": "sample string 4",
  "type": "sample string 5",
  "message": "sample string 6",
  "viewed": true,
  "closed": true,
  "orderNumber": 9,
  "userId": "a0c581ec-7b50-44d5-9284-fd316fed2163"
}

text/plain

Sample:

{"id":1,"startDate":"2025-10-31T14:02:06.6985552+01:00","endDate":"2025-10-31T14:02:06.6985552+01:00","channel":"sample string 4","type":"sample string 5","message":"sample string 6","viewed":true,"closed":true,"orderNumber":9,"userId":"a0c581ec-7b50-44d5-9284-fd316fed2163"}

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-10-31T14:02:06.6985552+01:00</EndDate>
  <Id>1</Id>
  <Message>sample string 6</Message>
  <OrderNumber>9</OrderNumber>
  <StartDate>2025-10-31T14:02:06.6985552+01:00</StartDate>
  <Type>sample string 5</Type>
  <UserId>a0c581ec-7b50-44d5-9284-fd316fed2163</UserId>
  <Viewed>true</Viewed>
</NotificationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/octet-stream

Sample:

{"Id":1,"StartDate":"2025-10-31T14:02:06.6985552+01:00","EndDate":"2025-10-31T14:02:06.6985552+01:00","Channel":"sample string 4","Type":"sample string 5","Message":"sample string 6","Viewed":true,"Closed":true,"OrderNumber":9,"UserId":"a0c581ec-7b50-44d5-9284-fd316fed2163"}

Response Information

Resource Description

HttpResponseMessage

Name	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.