POST cyapi/pos/getVipCoupon

Request Information

URI Parameters

None.

Body Parameters

GetVipCouponRequest_pos
NameDescriptionTypeAdditional information
requestParam

GetVipCouponRequestParam

None.

sktno

string

None.

terminalNo

string

None.

proType

integer

None.

version

string

None.

timeStamp

string

None.

Request Formats

application/json, text/json

Sample:
{
  "requestParam": {
    "condType": 1,
    "condValue": "sample string 2",
    "verifycode": "sample string 3",
    "storeCode": "sample string 4",
    "cardCodeToCheck": "sample string 5",
    "requireValidDate": true
  },
  "sktno": "sample string 1",
  "terminalNo": "sample string 2",
  "proType": 3,
  "version": "sample string 4",
  "timeStamp": "sample string 5"
}

application/xml, text/xml

Sample:
<GetVipCouponRequest_pos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PosLibrary.PubData">
  <proType>3</proType>
  <sktno>sample string 1</sktno>
  <terminalNo>sample string 2</terminalNo>
  <timeStamp>sample string 5</timeStamp>
  <version>sample string 4</version>
  <requestParam>
    <cardCodeToCheck>sample string 5</cardCodeToCheck>
    <condType>1</condType>
    <condValue>sample string 2</condValue>
    <requireValidDate>true</requireValidDate>
    <storeCode>sample string 4</storeCode>
    <verifycode>sample string 3</verifycode>
  </requestParam>
</GetVipCouponRequest_pos>

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

Response Information

Resource Description

GetVipCouponResponse_pos
NameDescriptionTypeAdditional information
responseData

GetVipCouponResponseData

None.

retCode

string

None.

retMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "responseData": {
    "vipId": 1,
    "vipCode": "sample string 2",
    "couponList": [
      {
        "couponType": 1,
        "couponTypeName": "sample string 2",
        "balance": 3.1,
        "deadline": "sample string 4"
      },
      {
        "couponType": 1,
        "couponTypeName": "sample string 2",
        "balance": 3.1,
        "deadline": "sample string 4"
      }
    ]
  },
  "retCode": "sample string 1",
  "retMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<GetVipCouponResponse_pos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PosLibrary.PubData">
  <retCode>sample string 1</retCode>
  <retMessage>sample string 2</retMessage>
  <responseData>
    <couponList>
      <PosCoupon>
        <balance>3.1</balance>
        <couponType>1</couponType>
        <couponTypeName>sample string 2</couponTypeName>
        <deadline>sample string 4</deadline>
      </PosCoupon>
      <PosCoupon>
        <balance>3.1</balance>
        <couponType>1</couponType>
        <couponTypeName>sample string 2</couponTypeName>
        <deadline>sample string 4</deadline>
      </PosCoupon>
    </couponList>
    <vipCode>sample string 2</vipCode>
    <vipId>1</vipId>
  </responseData>
</GetVipCouponResponse_pos>