Multitech FaxFinder FF130 Administrator User Manual page 99

Retrieving Contacts
User contacts are retrieved by sending a GET request to the contacts URL for a user. Or if you already
know the contact URL of a contact, then you could send a get request to that URL as well.
HTTP Request line:
GET /ffws/v1/contacts/USERNAME HTTP/1.0
Query Parameters:
limit=LIMIT
Limit the number of results to LIMIT.
offset=OFFSET
Skip OFFSET entries from the start. Only valid when limit is specified.
Substring matching for any of the contact elements.
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/contacts/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>
<contact>
<contact_url>https://192.168.2.1/ffws/v1/contacts/admin/3</contact_url>
<name>Contact Name</name>
<fax_number>111-222-4444</fax_number>
<phone_number>218-555-3336</phone_number>
<organization>Contacts Org</organization>
</contact>
</response>
Multi-Tech Systems, Inc. FaxFinder Admin User Guide
Appendix B: Customization
99