POST api/vending/getactivetokens

Get Active Token Codes

Request Information

URI Parameters

None.

Body Parameters

LimitRequest
NameDescriptionTypeAdditional information
Limit

Requested record limit

integer

None.

Offset

Requested offset starting from zero

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Limit": 1,
  "Offset": 2
}

application/xml, text/xml

Sample:
<LimitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vending.API.Classes">
  <Limit>1</Limit>
  <Offset>2</Offset>
</LimitRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Limited list of token results

LimitTokenResponse
NameDescriptionTypeAdditional information
Limit

integer

None.

Offset

integer

None.

RecordCount

integer

None.

Data

Collection of TokenResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Limit": 1,
  "Offset": 2,
  "RecordCount": 3,
  "Data": [
    {
      "Code": "sample string 1",
      "Credit": 2.0,
      "LastTransactionTime": 3,
      "DailyLimit": 4.0,
      "ServiceMode": true,
      "RemoteCreditService": 0,
      "BonusCode": "sample string 6",
      "Bonuses": [
        {
          "Position": 1,
          "Quantity": 2.0,
          "Type": 0
        },
        {
          "Position": 1,
          "Quantity": 2.0,
          "Type": 0
        }
      ]
    },
    {
      "Code": "sample string 1",
      "Credit": 2.0,
      "LastTransactionTime": 3,
      "DailyLimit": 4.0,
      "ServiceMode": true,
      "RemoteCreditService": 0,
      "BonusCode": "sample string 6",
      "Bonuses": [
        {
          "Position": 1,
          "Quantity": 2.0,
          "Type": 0
        },
        {
          "Position": 1,
          "Quantity": 2.0,
          "Type": 0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<LimitTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vending.BLL.Models">
  <Data>
    <TokenResult>
      <BonusCode>sample string 6</BonusCode>
      <Bonuses>
        <TokenBonusResult>
          <Position>1</Position>
          <Quantity>2</Quantity>
          <Type>Volume</Type>
        </TokenBonusResult>
        <TokenBonusResult>
          <Position>1</Position>
          <Quantity>2</Quantity>
          <Type>Volume</Type>
        </TokenBonusResult>
      </Bonuses>
      <Code>sample string 1</Code>
      <Credit>2</Credit>
      <DailyLimit>4</DailyLimit>
      <LastTransactionTime>3</LastTransactionTime>
      <RemoteCreditService>None</RemoteCreditService>
      <ServiceMode>true</ServiceMode>
    </TokenResult>
    <TokenResult>
      <BonusCode>sample string 6</BonusCode>
      <Bonuses>
        <TokenBonusResult>
          <Position>1</Position>
          <Quantity>2</Quantity>
          <Type>Volume</Type>
        </TokenBonusResult>
        <TokenBonusResult>
          <Position>1</Position>
          <Quantity>2</Quantity>
          <Type>Volume</Type>
        </TokenBonusResult>
      </Bonuses>
      <Code>sample string 1</Code>
      <Credit>2</Credit>
      <DailyLimit>4</DailyLimit>
      <LastTransactionTime>3</LastTransactionTime>
      <RemoteCreditService>None</RemoteCreditService>
      <ServiceMode>true</ServiceMode>
    </TokenResult>
  </Data>
  <Limit>1</Limit>
  <Offset>2</Offset>
  <RecordCount>3</RecordCount>
</LimitTokenResponse>