View source for OperatorAPI sections

''newadmapi (Operator API) function. Available to: '''Operator, SuperRoot'''.''

== Description ==
Every section this service serves, with what each offers and what THIS caller may do with it. Read-only. Paired with func=options, which describes one section in full: ask this what exists, then ask that how to talk to it - a client that reads both hardcodes neither the list of sections nor the shape of any one of them.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
 GET|POST https://YOUR_HOST:9089/newadm?func=sections
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=sections</code>.

== Example ==
 <nowiki>https://host:port/newadm?func=sections</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
  "ok":true,
  "data":{
    "sections":[
      {
        "section":s,
        "relation":s,
        "scope":s,
        "default_order":s,
        "fields":[
          s
        ],
        "writable":b,
        "complete":b,
        "can":{
          "insert":b,
          "update":b,
          "delete":b,
          "import":b
        },
        "options":s
      }
    ],
    "served":n,
    "complete":n,
    "verbs":s
  }
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]