Generic REST response wrapper for endpoints that support pagination.
Contains the requested page of results alongside pagination metadata and navigation links that allow clients to move through the full result set.
| name | data type | description |
|---|---|---|
| metadata | PagedResponseMetadata | PagedResponseMetadata including the limit, offset and totalCount of the response. |
| data | array of DSBPersonDTO | List of items retrieved from the endpoint. |
| links | PageNavigationLinks | PageNavigationLinks to the current, first, last, next and previous page. |
Example
{
"metadata" : {
"limit" : 12345,
"offset" : 12345,
"totalCount" : 12345
},
"data" : [ {
"uuid" : "...",
"nuLigaPersonId" : "...",
"firstname" : "...",
"lastname" : "...",
"birthyear" : 12345,
"gender" : "MALE",
"fideId" : 12345,
"rating" : 12345,
"index" : 12345,
"memberships" : [ {
"vkz" : "...",
"memberNo" : "...",
"clubName" : "...",
"licenceState" : "ACTIVE",
"regionName" : "...",
"federationName" : "..."
}, {
"vkz" : "...",
"memberNo" : "...",
"clubName" : "...",
"licenceState" : "ACTIVE",
"regionName" : "...",
"federationName" : "..."
} ],
"weekOfLastTournamentEvaluation" : "..."
}, {
"uuid" : "...",
"nuLigaPersonId" : "...",
"firstname" : "...",
"lastname" : "...",
"birthyear" : 12345,
"gender" : "FEMALE",
"fideId" : 12345,
"rating" : 12345,
"index" : 12345,
"memberships" : [ {
"vkz" : "...",
"memberNo" : "...",
"clubName" : "...",
"licenceState" : "PASSIVE",
"regionName" : "...",
"federationName" : "..."
}, {
"vkz" : "...",
"memberNo" : "...",
"clubName" : "...",
"licenceState" : "PASSIVE",
"regionName" : "...",
"federationName" : "..."
} ],
"weekOfLastTournamentEvaluation" : "..."
} ],
"links" : {
"self" : "...",
"first" : "...",
"last" : "...",
"next" : "...",
"previous" : "..."
}
}