POST api/cardService/v1/user/communicationSettings

Request Information

URI Parameters

None.

Body Parameters

SetUserCommunicationSettingsRequestModel

Name	Type	Additional information
CardHolderId	string	None.
ManualTopup	CommunicationOptionModel	None.
AutoTopup	CommunicationOptionModel	None.
Transaction	CommunicationOptionModel	None.

Request Formats

application/json, text/json

Sample:

{
  "CardHolderId": "sample string 1",
  "ManualTopup": {
    "SMS": true,
    "Email": true
  },
  "AutoTopup": {
    "SMS": true,
    "Email": true
  },
  "Transaction": {
    "SMS": true,
    "Email": true
  }
}

application/xml, text/xml

Sample:

<SetUserCommunicationSettingsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels.User">
  <AutoTopup>
    <Email>true</Email>
    <SMS>true</SMS>
  </AutoTopup>
  <CardHolderId>sample string 1</CardHolderId>
  <ManualTopup>
    <Email>true</Email>
    <SMS>true</SMS>
  </ManualTopup>
  <Transaction>
    <Email>true</Email>
    <SMS>true</SMS>
  </Transaction>
</SetUserCommunicationSettingsRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseApiResponse

Name	Type	Additional information
IsSuccess	boolean	Required
ErrorCodes	Collection of string	Required
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "ErrorCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<BaseApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels">
  <ErrorCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorCodes>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
</BaseApiResponse>