GET catalog/…/content

Retrieves the content of a catalog

A catalog can contain any number of playables. The playables are sorted by their name.

Resource URL

https://www.drillster.com/api/3/catalog/{catalogId}/content

Parameters

Field Type Description
catalogId String The ID of the catalog
query String An optional filter on the catalog content's name and subject. Specify this if you want to see only specific playables.
resultFrom String The value of the pagination.lastOnPage from the previous page. Use this parameter to determine the first element of the returned result. If it is not specified, the first page will be displayed.
resultSize Integer The maximum number of playables to return. Defaults to 10.

Response

A 2.1.1 PlayableContainerContent object.

Example

{
  "playableContainer": {
    "id": "fgCCrnI-QYqg0dsBC2eGSA",
    "name": "Class 4B",
    "icon": {
      "url": "https://www.drillster.com/bin/avatar/4606ffb1507d434df480adbedd8c38f474754f6f",
      "type": "image/jpeg"
    },
    "organization": {
      "id": "fgCCrnI-QYqg0dsBC2eGSA",
      "name": "Acme Inc.",
      "avatar": {
        "url": "https://www.drillster.com/bin/avatar/4606ffb1507d434df480adbedd8c38f474754f6f",
        "type": "image/jpeg"
      },
      "contract": {
        "id": "fVxjyNo3UibpSrlPsCbGOg",
        "created": "2020-01-20T16:25:45Z"
      }
    }
  },
  "pagination": {
    "total": 112,
    "lastOnPage": "fgCCrnI-QYqg0dsBC2eGSA"
  }
}

Error responses

The following error situations are possible:

ID Response code Description
not_linked_to_organization 401 (Unauthorized) You are not an administrator of an organization
not_permitted 403 (Forbidden) You are not allowed to request this catalog's content
catalog_not_found 404 (Not found) The requested catalog is not found

 

Last updated on