Filter
Top Products
Appendix B: Customization
Multi-Tech Systems, Inc. FF240-IP Admin User Guide 105
Retrieving Contact Groups
HTTP Request line:
GET /ffws/v1/contact_groups/USERNAME HTTP/1.1
GET /ffws/v1/contact_groups/global_contact_list HTTP/1.1
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
description=SUBSTR
Search for groups by field name. If you specify more than one, they are
logically ANDed.
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/contact_groups/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_group>
<contact_group_url>https://172.16.128.5/ffws/v1/contact_groups/admin/4
</contact_group_url>
<name>g one</name>
<description>g one</description>
<contact>https://172.16.128.5/ffws/v1/contacts/admin/1</contact>
<contact>https://172.16.128.5/ffws/v1/contacts/admin/2</contact>
<contact>https://172.16.128.5/ffws/v1/contacts/global_contact_list/3
</contact>
</contact_group>
<contact_group>
<contact_group_url>https://172.16.128.5/ffws/v1/contact_groups/admin/6
</contact_group_url>
<name>g two</name>
<description>g two org</description>
<contact>https://172.16.128.5/ffws/v1/contacts/admin/2</contact>
<contact>https://172.16.128.5/ffws/v1/contacts/global_contact_list/4
</contact>
</contact_group>
</response>