/departments/search

GET

Department query API which returns matching links to other departments

Parameters

Name Type Description
q query Query search term
limit query The number of items requested, defaulted to 50 and limited to 1000.
offset query The first row of resources to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter.

Responses

200: OK

Example value
{
  "type": "object",
  "required": [
    "count",
    "took"
  ],
  "properties": {
    "count": {
      "description": "Number of search results which match query",
      "type": "number",
      "example": 80
    },
    "items": {
      "description": "List of matching content items for the current page",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "matches": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "terms": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "name": {
            "type": "string"
          },
          "terms": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "took": {
      "description": "Time taken to execute query in milliseconds",
      "type": "number",
      "example": 530
    }
  }
}

400: Query term not specified

Example value
null

500: Internal server error

Example value
null