POST api/Common/AddNotification

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Businessid	integer	None.
Loginuserid	integer	None.
AgentId	integer	None.
MessageTitle	string	None.
MessageBody	string	None.
notificationButtonLink	string	None.
notificationButtonText	string	None.
FirebaseLogID	string	None.
tokenDetails	Collection of TokenDetails	None.

Request Formats

application/json, text/json

Sample:

{
  "Businessid": 1,
  "Loginuserid": 2,
  "AgentId": 3,
  "MessageTitle": "sample string 4",
  "MessageBody": "sample string 5",
  "notificationButtonLink": "sample string 6",
  "notificationButtonText": "sample string 7",
  "FirebaseLogID": "sample string 8",
  "tokenDetails": [
    {
      "AgentId": 1,
      "Token": "sample string 2"
    },
    {
      "AgentId": 1,
      "Token": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AddNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <AgentId>3</AgentId>
  <Businessid>1</Businessid>
  <FirebaseLogID>sample string 8</FirebaseLogID>
  <Loginuserid>2</Loginuserid>
  <MessageBody>sample string 5</MessageBody>
  <MessageTitle>sample string 4</MessageTitle>
  <notificationButtonLink>sample string 6</notificationButtonLink>
  <notificationButtonText>sample string 7</notificationButtonText>
  <tokenDetails>
    <TokenDetails>
      <AgentId>1</AgentId>
      <Token>sample string 2</Token>
    </TokenDetails>
    <TokenDetails>
      <AgentId>1</AgentId>
      <Token>sample string 2</Token>
    </TokenDetails>
  </tokenDetails>
</AddNotification>

application/x-www-form-urlencoded

Sample:

Sample not available.

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 03:38:25",
  "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>