Get qtype vocab

Returns the question-types vocabulary, with each type annotated with whether the current user's subscription tier allows it.

GET /++get_qtype_vocab

Platform & Utilities

Authentication

Requires an authenticated (logged-in) account. Also requires a registered Integrator subscription.

This endpoint requires the calling application to be registered as an Integrator. Every call must identify the registration via a registration_id parameter (or an X-Client-Id header), and authenticate using one of the following methods, selected with the subscription_method parameter:

referer — The request's HTTP Referer header must match one of the domains authorized for this Integrator registration.
ip — The request's source IP address must match one of the IP addresses authorized for this Integrator registration.
client_token — A client token issued at registration time is supplied with the request.

Request

Content type: application/json

Name	In	Type	Required	Description
`SearchableText`	query	string	No	Sent by the web client (found via frontend call-site tracing).
`batch_size`	query	string	No	Sent by the web client (found via frontend call-site tracing).
`path`	query	string	No	Sent by the web client (found via frontend call-site tracing).
`portal_type`	query	string	No	Sent by the web client (found via frontend call-site tracing).
`subjects`	query	string	No	Sent by the web client (found via frontend call-site tracing).
`vocab`	query	string	No	Sent by the web client (found via frontend call-site tracing).

Responses

Status	Meaning
`200`	Successful response.
`401`	Unauthorized - missing or invalid Integrator authentication (registration_id/X-Client-Id, plus referer/IP/client_token).
`403`	Forbidden - the current user or Integrator registration does not have sufficient permissions.

Example response (illustrative - field names only, values are placeholders)

{
  "error": "example_value"
}

Platform & Utilities