Response format

Standard response structure and field meanings.

Every action returns a JSON or XML payload.

JSON responses use a result array.

Envelope

{
  "result": [
    {
      "status": "success",
      "message": ["..."]
    }
  ]
}

• getdicts can return multiple array elements (one per dictionary).

• All other actions return exactly one element.

status values

• success: the operation completed.

• warning: the operation partially succeeded.

• error: the operation failed.

For warning, check message.

For word operations, warnings usually list which words were skipped.

Fields

These are the fields you can see in result[] objects.

Field	Type	Meaning
id	integer	Numeric dictionary ID.
lang	string	Dictionary language.
description	string	Dictionary label.
wordlist	array of strings	Words returned or affected by the action.
count	integer	Word count (when present).
state	boolean	Enabled state (when present).
status	string	success, warning, or error.
message	array of strings	Human-readable messages.

Which actions include which fields

• wordlist appears in: create, addwords, deletewords, getwords.

• count appears in: getwords, getdicts.

• state appears in: getdicts, edit.

getdicts returns metadata only. Use getwords to fetch the word list.

Dictionary action fields

For create, delete, edit, and getdicts, the response includes two additional top-level fields alongside result:

Field	Type	Description
dictionary_limit	integer	The effective maximum number of dictionaries allowed for this service ID.
dictionary_usage	integer	The current total dictionary count for this service ID. Always reflects the full count, regardless of any filters applied.

These fields are not present in word actions (addwords, deletewords, getwords).