Something went wrong. Try again.
New TLE Community website using Eleventy. tlecommunity.com
Something went wrong. Try again.
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667---jsconst pagination = { data: 'apiSpec.modules', size: 1, alias: 'module',}const eleventyComputed = { title: (data) => `${data.module.name} - API reference`, permalink: (data) => `/developers/api/reference/${data.module.slug}/`,}---{% from "partials/api-schema.njk" import schema %}<h1><code>{{ module.name }}</code></h1>{% if module.description %}<p>{{ module.description }}</p>{% endif %}<p> <a href="/developers/api/reference/">All modules</a> · {{ module.operationCount }} method{{ 's' if module.operationCount != 1 }}</p><p> Every call is an HTTP <code>POST</code>. The response body is the JSON-RPC envelope <code>{ "id", "jsonrpc", "result" }</code>; the <strong>Result</strong> schema below describes <code>result</code>. Errors come back as HTTP 500 with an <a href="/developers/api/error-codes/"><code>rpc_error</code></a> body.</p>{% for op in module.operations %}<section> <h2 id="{{ op.anchor }}"><code>{{ op.method }}</code></h2> {% if op.summary %}<p>{{ op.summary }}</p>{% endif %} <p><code>POST {{ op.route }}</code></p> {% if op.description %}<p>{{ op.description }}</p>{% endif %} {% if op.auth %} <p> <strong>Auth:</strong> send the header <code>Authorization: Token <session_id></code> (see <a href="/developers/api/api-keys/">API keys</a>). </p> {% endif %} {% if op.errorCodes.length %} <p> <strong>Throws:</strong> {%- for code in op.errorCodes %} {{ code }}{{ ',' if not loop.last }}{% endfor %} (<a href="/developers/api/error-codes/">error codes</a>) </p> {% endif %} <h3 id="{{ op.anchor }}-request">Request body</h3> {% if op.requestSchema %} {{ schema(op.requestSchema, apiSpec.schemas) }} {% else %} <p>No request body.</p> {% endif %} <h3 id="{{ op.anchor }}-result">Result</h3> {{ schema(op.resultSchema, apiSpec.schemas) }}</section>{% endfor %}