1. Home
2. JSON
3. PagedResponseOfDSBFederationDTO

PagedResponseOfDSBFederationDTO Data Type

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.

• data – The items on this page.
• metadata – PagedResponseMetadata of the response.
• links – PageNavigationLinks to the current, first, last, next and previous page.

Properties

name	data type	description
links	PageNavigationLinks	PageNavigationLinks to the current, first, last, next and previous page.
data	array of DSBFederationDTO	List of items retrieved from the endpoint.
metadata	PagedResponseMetadata	PagedResponseMetadata including the limit, offset and totalCount of the response.

Example

{
  "links" : {
    "self" : "...",
    "first" : "...",
    "last" : "...",
    "next" : "...",
    "previous" : "..."
  },
  "data" : [ {
    "federationNumber" : "...",
    "federation" : "...",
    "parentFederation" : "...",
    "federationName" : "..."
  }, {
    "federationNumber" : "...",
    "federation" : "...",
    "parentFederation" : "...",
    "federationName" : "..."
  } ],
  "metadata" : {
    "limit" : 12345,
    "offset" : 12345,
    "totalCount" : 12345
  }
}