X-Git-Url: https://git.defcon.no/?a=blobdiff_plain;f=doc%2Fapi-nodes.txt;fp=doc%2Fapi-nodes.txt;h=cb6ea9a2dfed330f9d9b3e414480a1b2ad456540;hb=3b7b5ca848177cc351e0ee623cd9621b7a46eb7b;hp=03b82b6f867627e8d94dda5c729f35a6f4c6da71;hpb=60bf626a9d34dee29c5644a2a5c8c24829c87f13;p=hermes diff --git a/doc/api-nodes.txt b/doc/api-nodes.txt index 03b82b6..cb6ea9a 100644 --- a/doc/api-nodes.txt +++ b/doc/api-nodes.txt @@ -449,7 +449,9 @@ phone/list a subset matching on the MAC addresses. Return: - TODO: Document this. + Returns 'list' as a simple array of registered MAC-adresses on success, + the list will be limited to addresses matching the search if provided. + phone/add ------------------- @@ -483,7 +485,7 @@ phone/remove are identical to the phone/add node. Return: - TODO: Document additional info provided on 'result' = 'ok' + Returns 'mac', 'username' and 'domain' on success. Returns 'failed' with 'cause' = 'invalid' if SIP address is malformed. Returns 'failed' with 'cause' = 'invalid' if MAC address is malformed. Returns 'failed' with 'cause' = 'nonexistant' on no such registration.