GET v1/gameListSummaries/page/{pageNumber}/perpage/{perPage}/sort/{sort}/direction/{direction}
Returns an array of all GameListSummaries
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| pageNumber |
Page Number. |
integer |
Default value is 1 |
| perPage |
Items Per Page. |
integer |
Default value is 10 |
| sort |
Field to sort on. |
SummaryReportField |
Default value is GameName |
| direction |
direction of the sort. |
string |
Default value is asc |
Body Parameters
None.
Response Information
Resource Description
An Object containing the Summary Report
SummaryReportResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Page | integer |
None. |
|
| PerPage | integer |
None. |
|
| Total | integer |
None. |
|
| Sort | SummaryReportField |
None. |
|
| Direction | string |
None. |
|
| Summaries | Collection of GameListSummary |
None. |
Response Codes
- 200 OK: All GameListSummaries returned successfully
- 401 Unauthorized:
- 500 InternalServerError:
Response Formats
application/json, text/json
Sample:
{
"Page": 1,
"PerPage": 2,
"Total": 3,
"Sort": 0,
"Direction": "sample string 4",
"Summaries": [
{
"Id": "sample string 1",
"Name": "sample string 2",
"TypeName": "sample string 3",
"TokensIssued": 4,
"GamePlays": 5,
"GamesPlayed": 6,
"ExpirationDate": "2025-12-11T17:06:55.2196132Z",
"LastTokenIssued": "2025-12-11T17:06:55.2196132Z",
"LastGamePlayed": "2025-12-11T17:06:55.2196132Z"
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"TypeName": "sample string 3",
"TokensIssued": 4,
"GamePlays": 5,
"GamesPlayed": 6,
"ExpirationDate": "2025-12-11T17:06:55.2196132Z",
"LastTokenIssued": "2025-12-11T17:06:55.2196132Z",
"LastGamePlayed": "2025-12-11T17:06:55.2196132Z"
}
]
}
text/html
Sample:
{"Page":1,"PerPage":2,"Total":3,"Sort":0,"Direction":"sample string 4","Summaries":[{"Id":"sample string 1","Name":"sample string 2","TypeName":"sample string 3","TokensIssued":4,"GamePlays":5,"GamesPlayed":6,"ExpirationDate":"2025-12-11T17:06:55.2196132Z","LastTokenIssued":"2025-12-11T17:06:55.2196132Z","LastGamePlayed":"2025-12-11T17:06:55.2196132Z"},{"Id":"sample string 1","Name":"sample string 2","TypeName":"sample string 3","TokensIssued":4,"GamePlays":5,"GamesPlayed":6,"ExpirationDate":"2025-12-11T17:06:55.2196132Z","LastTokenIssued":"2025-12-11T17:06:55.2196132Z","LastGamePlayed":"2025-12-11T17:06:55.2196132Z"}]}
application/xml, text/xml
Sample:
<SummaryReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Responses">
<Direction>sample string 4</Direction>
<Page>1</Page>
<PerPage>2</PerPage>
<Sort>GameName</Sort>
<Summaries xmlns:d2p1="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Models">
<d2p1:GameListSummary>
<d2p1:ExpirationDate>2025-12-11T11:06:55.2196132-06:00</d2p1:ExpirationDate>
<d2p1:GamePlays>5</d2p1:GamePlays>
<d2p1:GamesPlayed>6</d2p1:GamesPlayed>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:LastGamePlayed>2025-12-11T11:06:55.2196132-06:00</d2p1:LastGamePlayed>
<d2p1:LastTokenIssued>2025-12-11T11:06:55.2196132-06:00</d2p1:LastTokenIssued>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:TokensIssued>4</d2p1:TokensIssued>
<d2p1:TypeName>sample string 3</d2p1:TypeName>
</d2p1:GameListSummary>
<d2p1:GameListSummary>
<d2p1:ExpirationDate>2025-12-11T11:06:55.2196132-06:00</d2p1:ExpirationDate>
<d2p1:GamePlays>5</d2p1:GamePlays>
<d2p1:GamesPlayed>6</d2p1:GamesPlayed>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:LastGamePlayed>2025-12-11T11:06:55.2196132-06:00</d2p1:LastGamePlayed>
<d2p1:LastTokenIssued>2025-12-11T11:06:55.2196132-06:00</d2p1:LastTokenIssued>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:TokensIssued>4</d2p1:TokensIssued>
<d2p1:TypeName>sample string 3</d2p1:TypeName>
</d2p1:GameListSummary>
</Summaries>
<Total>3</Total>
</SummaryReportResponse>