POST api/Common/UpdateNotificationOptInStatus

Request Information

URI Parameters

None.

Body Parameters

UpdateNotificationOptInStatus
NameDescriptionTypeAdditional information
loginUserId

integer

None.

optInStatus

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "loginUserId": 1,
  "optInStatus": 2
}

application/xml, text/xml

Sample:
<UpdateNotificationOptInStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <loginUserId>1</loginUserId>
  <optInStatus>2</optInStatus>
</UpdateNotificationOptInStatus>

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 'UpdateNotificationOptInStatus'.

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional 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": "2024/09/19 18:29:47",
  "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>