Opiq API (1.0.0)

Download OpenAPI specification:Download

Opiq API exposes endpoints for searching and accessing Opiq study materials.

Kits

Search kits

Searches content of all study kits for given search string.

Authorizations:

Opiq API key

query Parameters

search_string	string non-empty Search string. Text within quotes is interpreted as phrase and searched verbatim, for non-quoted text fuzzy search is used.
curriculums	Array of strings or null Comma-separated list of curriculum codes for filtering search results. Supported curriculum codes.
classes	Array of strings or null Comma-separated list of class codes for filtering search results.. Supported class codes.
subjects	Array of strings or null Comma-separated list of subject codes for filtering search results.. Supported subject codes.
page	integer <int32> [ 1 .. 10 ] Default: 1 Results page number

header Parameters

OPIQ-LOCALE

string

Locale to use for localizable texts in response. When no value is provided, default value et is used. Supported locales.

Responses

Response samples

200
400
401
403

Content type

application/json

{"pageNumber": 0,
"pageSize": 0,
"pageResult": [{"url": "string",
"kit": {"id": 0,
"title": "string"
},
"chapter": {"id": 0,
"title": "string"
},
"section": {"id": 0,
"title": "string"
},
"curriculums": [{"code": "string",
"name": "string"
}
],
"classes": [{"code": "string",
"name": "string"
}
],
"subjects": [{"code": "string",
"name": "string"
}
],
"thumbnailUrl": "string"
}
],
"totalCount": 0
}

Get related materials

Searches study kits for content related to given section’s text.

Authorizations:

Opiq API key

path Parameters

kitId required	integer <int32>
chapterId required	integer <int32>
sectionId required	integer <int32>

query Parameters

curriculums	Array of strings or null Comma-separated list of curriculum codes for filtering search results. Supported curriculum codes.
classes	Array of strings or null Comma-separated list of class codes for filtering search results. A collection of supported class codes or special values `classes:earlier`, `classes:same`, `classes:earlier`.
subjects	Array of strings or null Comma-separated list of subject codes for filtering search results. A collection of supported subject codes or special values `subjects:same`, `subjects:other`.
page	integer <int32> [ 1 .. 10 ] Default: 1 Results page number

header Parameters

OPIQ-LOCALE

string

Locale to use for localizable texts in response. When no value is provided, default value et is used. Supported locales.

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"pageNumber": 0,
"pageSize": 0,
"pageResult": [{"url": "string",
"kit": {"id": 0,
"title": "string"
},
"chapter": {"id": 0,
"title": "string"
},
"section": {"id": 0,
"title": "string"
},
"curriculums": [{"code": "string",
"name": "string"
}
],
"classes": [{"code": "string",
"name": "string"
}
],
"subjects": [{"code": "string",
"name": "string"
}
],
"thumbnailUrl": "string"
}
],
"totalCount": 0
}

Configuration

Get supported locales

Returns a list of supported locales.

Responses

Response samples

200

Content type

application/json

{"locales": ["string"
]
}

Get curriculums

Returns list of supported curriculums. Curriculum codes can be used to filter kit content search results.

Responses

Response samples

200

Content type

application/json

{"supported": true,
"curriculums": [{"code": "string",
"names": [{"locale": "string",
"name": "string"
}
]
}
]
}

Get classes

Returns list of supported classes. Class codes can be used to filter kit content search results.

Responses

Response samples

200

Content type

application/json

{"classes": [{"code": "string",
"names": [{"locale": "string",
"name": "string"
}
]
}
]
}

Get subjects

Returns list of supported study kit subjects. Subjects codes can be used to filter kit content search results.

Responses

Response samples

200

Content type

application/json

{"subjects": [{"code": "string",
"names": [{"locale": "string",
"name": "string"
}
]
}
]
}