Contact And Group Functions; Viewing Contacts - Multitech FaxFinder FF240-IP Developer's Manual

Contact and Group Functions

Viewing Contacts

Query
Parameters
HTTP Request
Line
HTTP Response
Status Codes
Example
1 GET /ffws/v1/contacts/admin HTTP/1.1
2 content-type: application/xml
3 authorization: Basic YWRtaW46YWRtaW4=
4 -----------------------------------
5 HTTP/1.1 200 OK
6 content-type: application/xml
7 <?xml version="1.0" encoding="UTF-8"?>
8 <response>
9 <message>Success</message>
10 <contact>
11 <contact_url>https://192.168.2.1/ffws/v1/contacts/admin/3</contact_url>
12 <name>Contact Name</name>
13 <fax_number>218-555-3335</fax_number>
14 <phone_number>218-555-3336</phone_number>
15 <organization>Contacts Org</organization>
16 </contact>
17 </response>
FaxFinder Web Services API Developer Guide
limit=LIMIT
Limit the number of results to LIMIT.
offset=OFFSET
Skip OFFSET entries from the start. Only valid when limit is specified.
name=SUBSTR
fax_number=SUBSTR
phone_number=SUBSTR
organization=SUBSTR
Search for contacts by field name. If you specify more than one, they are
concatenated with AND.
order=field name
Sort contacts by field name. Not available for FFx30 models.
GET /ffws/v1/contacts/USERNAME HTTP/1.1
GET /ffws/v1/contacts/USERNAME/ID HTTP/1.1
GET /ffws/v1/contacts/global_contact_list HTTP/1.1
GET /ffws/v1/contacts/global_contact_list/ID HTTP/1.1
200 OK Shows contact information.
403 Forbidden Authenticated user does not have permission to view data
associated with username.
404 Not Found No user found with that username.
CONTACT AND GROUP FUNCTIONS
14