Word

Endpoint: /api/v2/word

Parameters

Parameter	Description
wid	Word ID to lookup within module
moduleId	Module ID within which to find word

Example: /api/v2/word?wid=3&moduleId=8

Returns

Types for the /word endpoint return are:

type WordAttribute = {
    key: string
    value: string
}
type WordEndpointResult = {
    data: WordAttribute[]
}

Property	Description
key	String internal code for attribute. key should be used in searchTerms but not displayed: it should be translated to a user-facing string using TOOD: currently a fixed file but should come from the data pipeline and be supplied by an endpoint?.
value	String value, possibly in need of translation to user-friendly value.