CategoryPaginatedResponse

The response object for paginated API requests.

metadata
Type: object · PaginationMetadata
- limit
  Type: integer Format: int32
  
  Gets or sets the limit used in the original request.
- links
  Type: object · Links
  
  Navigation links in the paginated response.
- offset
  Type: integer Format: int32
  
  Gets or sets the offset used in the original request.
- total
  Type: integer Format: int32
  
  Gets or sets the total number of records in the results set.
results
Type: array object[] | null · Category[]

Gets or sets the results set.
Represents a news category.
- categoryId
  Type: integer Format: int32
  
  The identifier of the category.
- categoryName
  Type: string | null
  
  The name of the category.
- categoryShortName
  Type: string | null
  
  The short name of the category.
- parentCategoryId
  Type: integer Format: int32
  
  If this category is a child category, it indicates the identifier of the parent category.

Examples

{
  "metadata": {
    "links": {
      "self": "https://test-news-rest-api.openmarkets.com.au/v2/categories?limit=10&offset=0",
      "next": "https://test-news-rest-api.openmarkets.com.au/v2/categories?limit=10&offset=10",
      "previous": null
    },
    "limit": 10,
    "offset": 0,
    "total": 42
  },
  "results": [
    {
      "categoryId": 1,
      "parentCategoryId": 0,
      "categoryName": "Company Announcements",
      "categoryShortName": "ANN"
    },
    {
      "categoryId": 12,
      "parentCategoryId": 1,
      "categoryName": "Periodic Reports",
      "categoryShortName": "PERIODIC"
    },
    {
      "categoryId": 13,
      "parentCategoryId": 1,
      "categoryName": "Dividend Announcements",
      "categoryShortName": "DIVIDEND"
    }
  ]
}