List Format of Response Body of GET Calls
All GET calls that are not for a specific ID will return a list of items.
The basic Json schema and an example of this schema are shown below.
Json Schema
{
"type": "object",
"properties": {
"page": {
"type": "object",
"properties": {
"pageSize": { "type": "integer" },
"page": { "type": "integer" },
"totalCount":{type:"long" }
},
"required": [ "pageSize", "page"]
},
"contents": {
"type": "array",
"items": [
{
"type": "object"
}
]
}
},
"required": [
"page",
"contents"
]
}
Example of Json Response Body From a GET Call That Provides Lists
Each set of brackets ( [ ] ) indicates a list, and each entry with curly braces ( { } ) is an item in that list.
{
"page": {
"pageSize": 5,
"page": 3,
"totalCount":441
},
"contents": [
{
"guid": "uniqueId",
"property1": "propertyValue",
"property2": "property2Value"
},
{
"guid": "differentUniqueId",
"property1": "propertyValueForItem2",
"property2": "property2ValueForItem2"
}
]
}
For an example of the response body that shows all the DPSKs within a specific DPSK
pool, see
Example of Using GET to Obtain
Listings of Multiple DPSKs Within an Existing DPSK Pool
For an example of changing the Page properties (the first part of the response body shown above), see Example of Changing Page Properties in a GET Call