View source for OperatorAPI session:menu

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

== Description ==
The menu this operator may see, NESTED as the legacy renders it: the rows of web_menus for their root, filtered by their groups, built into containers and leaves. A leaf carries served=true and the func to call when this API serves that section, and served=false with func=null when it does not - drawn but not navigable, so the panel shows the whole old menu without offering a route that would refuse. Presentation only: every route authorizes independently, so a section absent here is refused by the route as well, not merely unlisted.

== Call ==
 GET|POST https://YOUR_HOST:9089/newadm?func=session:menu
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=session:menu</code>.

== Example ==
 <nowiki>https://host:port/newadm?func=session:menu</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":{
    "operator":{
      "accountcode":s,
      "name":s,
      "groups":[
        s
      ],
      "readonly":b
    },
    "menu":[
      {
        "id":n,
        "title":s,
        "icon":s,
        "detail":s,
        "children":[
          ...
        ]
      }|{
        "id":n,
        "title":s,
        "icon":s,
        "detail":s,
        "section":s,
        "served":b,
        "func":s|null,
        "write":{
          "add":b,
          "edit":b,
          "delete":b
        }
      }
    ],
    "progress":{
      "sections":n,
      "served":n
    }
  }
}
</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]]