diff options
author | Ivan Kohler <ivan@freeside.biz> | 2015-07-21 19:16:06 -0700 |
---|---|---|
committer | Ivan Kohler <ivan@freeside.biz> | 2015-07-21 19:16:06 -0700 |
commit | c39d6e73a98427d653e3d019aaa90f16bc1b6380 (patch) | |
tree | 16cdc37fd2ad6eb6c4ffa0584569fe65a27b49d3 /fs_selfservice | |
parent | 4e63920a6b29e4e0b2321f80427211816d697612 (diff) |
self-service API list_contacts doc, RT#37372
Diffstat (limited to 'fs_selfservice')
-rw-r--r-- | fs_selfservice/FS-SelfService/SelfService.pm | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/fs_selfservice/FS-SelfService/SelfService.pm b/fs_selfservice/FS-SelfService/SelfService.pm index 06dcc2b05..e01d17b6a 100644 --- a/fs_selfservice/FS-SelfService/SelfService.pm +++ b/fs_selfservice/FS-SelfService/SelfService.pm @@ -1375,6 +1375,46 @@ error message, or empty on success. =item list_contacts +Takes a hash reference as parameter with a single key, B<session_id>. + +Returns a hash reference with two parameters: B<error>, which contains an error +message, or empty on success, and B<contacts>, a list of contacts. + +B<contacts> is an array reference of hash references (i.e. an array of structs, + in XML-RPC). Each hash reference (struct) has the following keys: + +=over4 + +=item contactnum + +=item class + +Contact class name (contact type). + +=item first + +First name + +=item last + +Last name + +=item title + +Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.") + +=item emailaddress + +Comma-separated list of email addresses + +=item comment + +=item selfservice_access + +Y when enabled + +=back + =item edit_contact Updates information for the currently-logged in contact, or (optionally) the |