View source for OperatorAPI poll

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

== Description ==
Polls a login started with func=request. Returns pending, ok, expired or consumed. On the FIRST ok it returns a SHORT, server-revocable session token - never the permanent key.

== Call ==
 GET|POST https://YOUR_HOST:9089/newadm?func=poll
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 ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>session_code</code> || string || Yes || &mdash; || From func=request.
|}
== Example ==
 <nowiki>https://host:port/newadm?func=poll&session_code=CODE</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: <code>{"ok":true,"data":{"status":s,"session":s?}}</code>.

== 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]]