POST api/Common/AddUpdateMessages
Request Information
URI Parameters
None.
Body Parameters
AddUpdateMessages| Name | Description | Type | Additional information |
|---|---|---|---|
| businessId | integer |
None. |
|
| userId | integer |
None. |
|
| flag | integer |
None. |
|
| announcementId | integer |
None. |
|
| messageTitle | string |
None. |
|
| messageBody | string |
None. |
|
| receivers | string |
None. |
|
| roles | string |
None. |
|
| announcementTypeId | integer |
None. |
|
| scheduledDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"businessId": 1,
"userId": 2,
"flag": 3,
"announcementId": 4,
"messageTitle": "sample string 5",
"messageBody": "sample string 6",
"receivers": "sample string 7",
"roles": "sample string 8",
"announcementTypeId": 9,
"scheduledDate": "2025-11-03T15:58:29.2815433+00:00"
}
application/xml, text/xml
Sample:
<AddUpdateMessages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model"> <announcementId>4</announcementId> <announcementTypeId>9</announcementTypeId> <businessId>1</businessId> <flag>3</flag> <messageBody>sample string 6</messageBody> <messageTitle>sample string 5</messageTitle> <receivers>sample string 7</receivers> <roles>sample string 8</roles> <scheduledDate>2025-11-03T15:58:29.2815433+00:00</scheduledDate> <userId>2</userId> </AddUpdateMessages>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VCAPIResponse| Name | Description | 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/11/03 15:58:29",
"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>