Get image tagging search
Image search service for the Image Tagging question type's manage-side builder (browser/static/js/manage/questiontypes/image_tagging.js) -- lets a teacher/admin search the whole site for an image to tag, without needing a separate admin/teacher branch in this code at all.
GET
/++image_tagging_search
Platform & Utilities
Authentication
Public — no authentication required. 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.
Register as an Integrator and configure authorized domains, IP addresses, or a client token.
Request
Content type: application/json
| Name | In | Type | Required | Description |
|---|---|---|---|---|
SearchableText | query | string | No | Alternative to `query` - provide this OR query, not both required. |
query | query | string | No | Alternative to `SearchableText` - provide this OR SearchableText, not both required. |
UID | query | string | No | Alternative to `uid` - provide this OR uid, not both required. |
uid | query | string | No | Alternative to `UID` - provide this OR UID, not both required. |
Responses
| Status | Meaning |
|---|---|
200 | Successful response. |
500 | Image search failed |
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)
{
"items": [
"... see the parameters/response fields below for the shape of each entry ..."
]
}
