Get categories

GET 
/categories

Get all supported categories

Request

Query Parameters

page number

Pagination page to start on

pageSize number

Pagination page size to use

Responses

200

Categories response

application/json

Schema

Schema

page numberrequired
totalItemCount numberrequired
totalPageCount numberrequired
previousPage string
nextPage string

items

object[]

required

Array [

docc string

ID of the category

name string

Name of the category

description string

Description of the category

]

Example (from schema)

{
  "page": 0,
  "totalItemCount": 0,
  "totalPageCount": 0,
  "previousPage": "string",
  "nextPage": "string",
  "items": [
    {
      "docc": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

401

Unauthorized client

403

Insufficient scope for accessing this resource

application/json

Schema

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

• BAD_REQUEST - Malformed request, please advice the description and details fields for more information
• FORBIDDEN - Insufficient scope to access the resource
• INTERNAL_SERVER_ERROR - Unexpected server error
• METHOD_NOT_ALLOWED - Method not allowed
• UNSUPPORTED_MEDIA_TYPE - Unsupported media type
• SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "string",
      "description": "string",
      "recoverable": false
    }
  ]
}

404

One or more resources within the request was not found

application/json

Schema

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

• BAD_REQUEST - Malformed request, please advice the description and details fields for more information
• FORBIDDEN - Insufficient scope to access the resource
• INTERNAL_SERVER_ERROR - Unexpected server error
• METHOD_NOT_ALLOWED - Method not allowed
• UNSUPPORTED_MEDIA_TYPE - Unsupported media type
• SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "string",
      "description": "string",
      "recoverable": false
    }
  ]
}

405

Method not allowed

application/json

Schema

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

• BAD_REQUEST - Malformed request, please advice the description and details fields for more information
• FORBIDDEN - Insufficient scope to access the resource
• INTERNAL_SERVER_ERROR - Unexpected server error
• METHOD_NOT_ALLOWED - Method not allowed
• UNSUPPORTED_MEDIA_TYPE - Unsupported media type
• SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "string",
      "description": "string",
      "recoverable": false
    }
  ]
}

500

Unexpected server error

application/json

Schema

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

• BAD_REQUEST - Malformed request, please advice the description and details fields for more information
• FORBIDDEN - Insufficient scope to access the resource
• INTERNAL_SERVER_ERROR - Unexpected server error
• METHOD_NOT_ALLOWED - Method not allowed
• UNSUPPORTED_MEDIA_TYPE - Unsupported media type
• SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

]

Example (from schema)

{
  "errors": [
    {
      "source": "string",
      "reasonCode": "string",
      "description": "string",
      "recoverable": false
    }
  ]
}

Loading...