POST api/Common/PostAnnouncement

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Businessid	integer	None.
Loginuserid	integer	None.
AgentIds	string	None.
MessageTitle	string	None.
MessageBody	string	None.
publishStatus	integer	None.
publishedAt	string	None.
Tokens	string	None.
IsEdit	integer	None.
NotificationId	integer	None.
MessageDetailsList	Collection of FirebaseMessageIdDetails	None.
tokenDetails	Collection of TokenDetails	None.
agentList	Collection of AgentList	None.
roles	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Businessid": 1,
  "Loginuserid": 2,
  "AgentIds": "sample string 3",
  "MessageTitle": "sample string 4",
  "MessageBody": "sample string 5",
  "publishStatus": 6,
  "publishedAt": "sample string 7",
  "Tokens": "sample string 8",
  "IsEdit": 9,
  "NotificationId": 10,
  "MessageDetailsList": [
    {
      "MessageId": 1,
      "AgentId": 2
    },
    {
      "MessageId": 1,
      "AgentId": 2
    }
  ],
  "tokenDetails": [
    {
      "AgentId": 1,
      "Token": "sample string 2"
    },
    {
      "AgentId": 1,
      "Token": "sample string 2"
    }
  ],
  "agentList": [
    {
      "AgentId": 1
    },
    {
      "AgentId": 1
    }
  ],
  "roles": "sample string 11"
}

application/xml, text/xml

Sample:

<PostAnnouncement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <AgentIds>sample string 3</AgentIds>
  <Businessid>1</Businessid>
  <IsEdit>9</IsEdit>
  <Loginuserid>2</Loginuserid>
  <MessageBody>sample string 5</MessageBody>
  <MessageDetailsList>
    <FirebaseMessageIdDetails>
      <AgentId>2</AgentId>
      <MessageId>1</MessageId>
    </FirebaseMessageIdDetails>
    <FirebaseMessageIdDetails>
      <AgentId>2</AgentId>
      <MessageId>1</MessageId>
    </FirebaseMessageIdDetails>
  </MessageDetailsList>
  <MessageTitle>sample string 4</MessageTitle>
  <NotificationId>10</NotificationId>
  <Tokens>sample string 8</Tokens>
  <agentList>
    <AgentList>
      <AgentId>1</AgentId>
    </AgentList>
    <AgentList>
      <AgentId>1</AgentId>
    </AgentList>
  </agentList>
  <publishStatus>6</publishStatus>
  <publishedAt>sample string 7</publishedAt>
  <roles>sample string 11</roles>
  <tokenDetails>
    <TokenDetails>
      <AgentId>1</AgentId>
      <Token>sample string 2</Token>
    </TokenDetails>
    <TokenDetails>
      <AgentId>1</AgentId>
      <Token>sample string 2</Token>
    </TokenDetails>
  </tokenDetails>
</PostAnnouncement>

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:50:10",
  "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>