GET v1/tokens/expired/{id}?pageIndex={pageIndex}&pageSize={pageSize}

Get a list of expired tokens for a given game

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the Game for which to retrieve expired tokens.

 string

Required
pageIndex

1-based index of the page to retrieve, if batches are to be used. Defaults to 1.

 integer

Default value is 1
pageSize

Size of each page. Defaults to 100.

 integer

Default value is 100

Body Parameters

None.

Response Information

Resource Description

A list of expired tokens, if any exist.

ExpiredTokensResponse
NameDescriptionTypeAdditional information
PageIndex

integer

None.
PageSize

integer

None.
ExpiredTokens

Collection of ExpiredToken

None.
TotalSize

integer

None.

Response Codes

  • 401 Unauthorized:
  • 404 NotFound: Game does not exist.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "PageIndex": 1,
  "PageSize": 2,
  "ExpiredTokens": [
    {
      "TokenId": "sample string 1",
      "ParticipantId": "sample string 2",
      "AwardValue": 1,
      "GameId": "sample string 3",
      "GameName": "sample string 4",
      "Reason": "sample string 5"
    },
    {
      "TokenId": "sample string 1",
      "ParticipantId": "sample string 2",
      "AwardValue": 1,
      "GameId": "sample string 3",
      "GameName": "sample string 4",
      "Reason": "sample string 5"
    }
  ],
  "TotalSize": 3
}

text/html

Sample: 
{"PageIndex":1,"PageSize":2,"ExpiredTokens":[{"TokenId":"sample string 1","ParticipantId":"sample string 2","AwardValue":1,"GameId":"sample string 3","GameName":"sample string 4","Reason":"sample string 5"},{"TokenId":"sample string 1","ParticipantId":"sample string 2","AwardValue":1,"GameId":"sample string 3","GameName":"sample string 4","Reason":"sample string 5"}],"TotalSize":3}

application/xml, text/xml

Sample: 
<ExpiredTokensResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Responses">
  <ExpiredTokens xmlns:d2p1="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Models">
    <d2p1:ExpiredToken>
      <d2p1:AwardValue>1</d2p1:AwardValue>
      <d2p1:GameId>sample string 3</d2p1:GameId>
      <d2p1:GameName>sample string 4</d2p1:GameName>
      <d2p1:ParticipantId>sample string 2</d2p1:ParticipantId>
      <d2p1:Reason>sample string 5</d2p1:Reason>
      <d2p1:TokenId>sample string 1</d2p1:TokenId>
    </d2p1:ExpiredToken>
    <d2p1:ExpiredToken>
      <d2p1:AwardValue>1</d2p1:AwardValue>
      <d2p1:GameId>sample string 3</d2p1:GameId>
      <d2p1:GameName>sample string 4</d2p1:GameName>
      <d2p1:ParticipantId>sample string 2</d2p1:ParticipantId>
      <d2p1:Reason>sample string 5</d2p1:Reason>
      <d2p1:TokenId>sample string 1</d2p1:TokenId>
    </d2p1:ExpiredToken>
  </ExpiredTokens>
  <PageIndex>1</PageIndex>
  <PageSize>2</PageSize>
  <TotalSize>3</TotalSize>
</ExpiredTokensResponse>