OperatorAPI usertardraft:list

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

Description

Lists STAGED customer sale rates - the drafts sys_update_all_rates makes live once entrance <= now. Tenant-scoped. The grid is the view, which resolves tariff, destination and prefix to names; writes go to the base table. 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=usertardraft: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=usertardraft:list.

Example

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

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: {"ok":true,"data":{"rows":[{"id":n,"tariff":s,"destination":s,"prefix":s,"pickup":n,"pickup_percent":n,"pickup_inc":n,"pickup_lock":n,"rate":n,"rate_percent":n,"rate_inc":n,"rate_lock":n,"minseg":n,"adjust_sec_billing":n,"entrance":s(ISO-8601, naive)}],"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