POST api/Notification/FCMSendNotification

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserId	integer	None.
DeviceId	integer	None.
OrderId	integer	None.
PipelineId	integer	None.
BusinessId	integer	None.
CustomerId	integer	None.
CustomerName	string	None.
ShipmentId	string	None.
NotificationType	NotificationType	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "DeviceId": 2,
  "OrderId": 3,
  "PipelineId": 4,
  "BusinessId": 5,
  "CustomerId": 6,
  "CustomerName": "sample string 7",
  "ShipmentId": "sample string 8",
  "NotificationType": 1
}

application/xml, text/xml

Sample:

<NotificationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BusinessId>5</BusinessId>
  <CustomerId>6</CustomerId>
  <CustomerName>sample string 7</CustomerName>
  <DeviceId>2</DeviceId>
  <NotificationType>CancelledOrder</NotificationType>
  <OrderId>3</OrderId>
  <PipelineId>4</PipelineId>
  <ShipmentId>sample string 8</ShipmentId>
  <UserId>1</UserId>
</NotificationModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NotificationModel'.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/04 06:34:01",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>