Collection API operations share a common JSON structure with context and pagination items.
Query parameters page and itemsPerPage are available to browse the collection.
- Minimum
itemsPerPage: 1 - Maximum
itemsPerPage: 100 - Default
itemsPerPage: 10 - Default
page: 1
Example
| GET | https://api.korusticket.com/v1/ticketing/catalogs?page=2&itemsPerPage=5 |
|---|---|
| itemsPerPage | 5 |
| page | 2 |
{
"@context": "/contexts/TicketingCatalog",
"@id": "/v1/ticketing/catalogs",
"@type": "Collection",
"totalItems": 2,
"member": [{...}],
"view": {
"@id": "/v1/ticketing/catalogs?itemsPerPage=5",
"@type": "PartialCollectionView"
},
"search": {
"@type": "IriTemplate",
"template": "/v1/ticketing/catalogs{?}",
"variableRepresentation": "BasicRepresentation",
"mapping": []
}
}