Viewing Contacts
|
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. 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. |
|
|
HTTP Request Line |
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 |
|
|
HTTP Response Status Codes |
200 OK |
Shows contact information. |
|
403 Forbidden |
Authenticated user does not have permission to view data. |
|
|
404 Not Found |
No user found with that username. |
|
Example
GET /ffws/v1/contacts/admin HTTP/1.1 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>218-555-3335</fax_number> <phone_number>218-555-3336</phone_number> <organization>Contacts Org</organization> </contact> </response>