GET api/cardService/v1/user/communicationSettings/cardHolderId/{cardHolderId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cardHolderId

string

Required

Body Parameters

None.

Response Information

Resource Description

GetUserCommunicationSettingsResponseModel
NameDescriptionTypeAdditional information
ManualTopup

CommunicationOptionModel

None.

AutoTopup

CommunicationOptionModel

None.

Transaction

CommunicationOptionModel

None.

IsSuccess

boolean

Required

ErrorCodes

Collection of string

Required

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ManualTopup": {
    "SMS": true,
    "Email": true
  },
  "AutoTopup": {
    "SMS": true,
    "Email": true
  },
  "Transaction": {
    "SMS": true,
    "Email": true
  },
  "IsSuccess": true,
  "ErrorCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Message": "sample string 2"
}

application/xml, text/xml

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