Appendix B: Customization
Multi-Tech Systems, Inc. FaxFinder Admin User Guide 100
Adding New Contacts
User contacts are added by sending a POST request to the contacts URL for a user. The body of the
request should contain valid XML for an contact element.
HTTP Request line:
POST /ffws/v1/contacts/USERNAME HTTP/1.0
HTTP Response Status Codes:
200 OK
Created
403 Forbidden
Authenticated user does not have permission to change data associated with
username.
404 Not Found
No user found with that username.
400 Bad Request
The provided XML is not valid.
Example:
POST /ffws/v1/contacts/admin HTTP/1.0
content-type: application/xml
authorization: Basic YWRtaW46YWRtaW4=
<?xml version="1.0" encoding="UTF-8"?>
<contact>
<name>Test Recipient</name>
<fax_number>111-222-4444</fax_number>
<phone_number>218-555-3336</phone_number>
<organization>Some org</organization>
</contact>
-----------------------------------
HTTP/1.1 200 OK
content-type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<response>
<message>Created</message>
<contact>
<contact_url>https://192.168.2.1/ffws/v1/contacts/admin/6</contact_url>
<name>Test Recipient</name>
<fax_number>111-222-4444</fax_number>
<phone_number>218-555-3336</phone_number>
<organization>Some org</organization>
</contact>
</response>
To Next Page
Loading...
