Appendix B: Customization
Multi-Tech Systems, Inc. FaxFinder Admin User Guide 98
Retrieving User Information
Information associate with a user can be retrieved by sending a GET request to the user URL of the user
desired. The user URL is of the form /ffws/v1/users/USERNAME. A regular user can only retrieve their
information and not that of another user.
HTTP Request line:
GET /ffws/v1/users/USERNAME HTTP/1.0
HTTP Response Status Codes:
200 OK
Success
403 Forbidden
Authenticated user does not have permission to view data associated with
username.
404 Not Found
No user found with that username.
Example:
GET /ffws/v1/users/admin HTTP/1.0
content-type: application/xml
authorization: Basic YWRtaW46YWRtaW4=
-----------------------------------
HTTP/1.1 200 OK
content-type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Success</message>
<user>
<user_url>https://192.168.2.1/ffws/v1/users/admin</user_url>
<name>Administrator</name>
<username>admin</username>
<email_address>admin@example.com</email_address>
<phone_number>111-222-3333</phone_number>
<fax_number>111-222-3334</fax_number>
<organization>Example Org</organization>
</user>
</response>
To Next Page
Loading...
