OperatorAPI didstock:list

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

Description

Lists the numbering STOCK. BOTH audiences now. The SUPER reads it GLOBALLY and unfiltered - adm's globallock is 1=1 with restrictions=() - which is what the tucloudpbx alta needs: a number is chosen from this stock. The OPERATOR keeps the legacy's lock = false restriction, applied to every operator caller on newadm's narrowest-for-everyone ruling. MEASURED COST of that operator restriction, on tucalldev and production alike: 3 accounts hold neither admin nor user (the two port integration accounts and the one none account) and they lose 7,597 of 13,763 rows. The OPERATOR can EDIT (fromip, nota; cli is IMMUTABLE - the trigger silently reverts any change, NEW.cli = OLD.cli). The SUPER is read-only for now, its write a separate follow-up. Paginated. Sorting and searching are restricted to the declared fields; anything else is rejected and named. Read audience is provisional pending operator confirmation.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=didstock:list

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

None beyond the API key and func=didstock:list.

Example

https://host:port/newadm?func=didstock:list

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape (n = number, s = string, ? = present only when set):

{
  "ok":true,
  "data":{
    "rows":[
      {
        "cli":s,
        "root":n,
        "province":s,
        "lock":b,
        "fromip":s,
        "nota":s
      }
    ],
    "page":n,
    "pagesize":n,
    "fields":[
      s
    ],
    "available":[
      s
    ],
    "order":s,
    "dir":s,
    "filterby":s?,
    "filter":s?
  }
}

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

Back to OperatorAPI