User Functions; Viewing User Information; Verify User - Multitech FaxFinder FF240-IP Developer's Manual

USER FUNCTIONS

User Functions

Viewing User Information

HTTP Request
Line
HTTP Response
Status Codes
Example
1 GET /ffws/v1/users/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 <user>
11 <user_url>https://dot3/ffws/v1/users/admin</user_url>
12 <name>Administrator</name>
13 <username>admin</username>
14 <email_address>cla@mts.test</email_address>
15 <phone_number>1234</phone_number>
16 <fax_number>2345</fax_number>
17 <organization>MTS</organization>
18 <default_cover_page_enabled>true</default_cover_page_enabled>
19 <default_cover_page_name>mts_template3.pdf</default_cover_page_name>
20 <priority>3</priority>
21 <max_attempts>3</max_attempts>
22 <interval>300</interval>
23 <receipt>failure</receipt>
24 <receipt_attachment>pdf</receipt_attachment>
25 </user>
26 </response>

Verify User

Authenticates the user and then simply returns 200 OK.
HTTP Request Line
HTTP Response Status
Codes
11
GET /ffws/v1/users/USERNAME HTTP/1.1
200 OK Shows user information.
403 Forbidden Authenticated user does not have permission to view data
associated with username.
404 Not Found No user found with that username.
GET /ffws/v1/verify HTTP/1.1
200 OK Verified
FaxFinder Web Services API Developer Guide