Example
1
GET /ffws/v1/verify 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>Verified</message>
10
</response>
Adding a User
HTTP Request
Line
HTTP Response
Status Codes
Example
1
POST /ffws/v1/users HTTP/1.1
2
content-type: application/xml
3
authorization: Basic YWRtaW46YWRtaW4=
4
<?xml
version="1.0" encoding="UTF-8"?>
5
<user>
6
<name>New User 1</name>
7
<username>user1</username>
8
<password>user1</password>
9
<email_address>admin@Example.com</email_address>
10
<phone_number>218-555-3333</phone_number>
11
<fax_number>218-555-3334</fax_number>
12
<organization>Example Org</organization>
13
<priority>1</priority>
14
<max_attempts>2</max_attempts>
15
<interval>600</interval>
16
<receipt>never</receipt>
17
<receipt_attachment>none</receipt_attachment>
18
</user>
19
-----------------------------------
20
<?xml
version="1.0" encoding="UTF-8"?>
21
<response>
22
<message>Created</message>
23
<user>
24
<user_url>https://172.16.0.3/ffws/v1/users/user1</user_url>
25
<name>New User 1</name>
26
<username>user1</username>
27
<email_address>admin@Example.com</email_address>
28
<phone_number>218-555-3333</phone_number>
29
<fax_number>218-555-3334</fax_number>
30
<organization>Example Org</organization>
31
<default_cover_page_enabled>false</default_cover_page_enabled>
32
<default_cover_page_name></default_cover_page_name>
33
<priority>1</priority>
FaxFinder Web Services API Developer Guide
POST /ffws/v1/users HTTP/1.1
200 OK
Created user.
403 Forbidden
Authenticated user does not have permission to change data
associated with username.
400 Bad Request
The provided XML is not valid.
USER FUNCTIONS
12
Need help?
Do you have a question about the FaxFinder FF240-IP and is the answer not in the manual?
Questions and answers