Viewing Inbound Routes

Requires FaxFinder 3.0.4 or higher.

HTTP Request Line

GET /ffws/v1/routes HTTP/1.1

GET /ffws/v1/routes/global HTTP/1.1

GET /ffws/v1/routes/lines HTTP/1.1 (FF240, FF440, or FF840)

GET /ffws/v1/routes/lines/line_number HTTP/1.1 (FF240, FF440, or FF840)

GET /ffws/v1/routes/default HTTP/1.1 (FF240-IP only)

GET /ffws/v1/routes/recipients HTTP/1.1

GET /ffws/v1/routes/recipients/ID HTTP/1.1

HTTP Response Status Codes

200 OK

Shows inbound routes.

400 Bad Request

The provided XML is not valid.

FF240, FF440, or FF840 Example All Inbound Routes

GET /ffws/v1/routes 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>
	<global>
		<destination>
			  <type>Email</type>
			  <value>cla@mts.test</value>
		</destination>
		<destination>
			  <destination_id>2</destination_id>
			  <type>Print</type>
			  <value>hp_printer</value>
		</destination>
	</global>
	<lines>
		<line>
			<line_number>1</line_number>
			<description>first line</description>
			<destination>
			<type>Email</type>
			<value>cla@mts.test</value>
			</destination>
		</line>
		<line>
			<line_number>2</line_number>
			<description>second line</description>
			<destination>
			<type>Notify</type>	
			<value>test@mts.test</value>
			</destination>
		</line>
	</lines>
	<recipients>
		<recipient>
			<recipient_id>1</recipient_id>
			<extension>1234</extension>
			<description>Yoda</description>
			<destination>
			<type>Email</type>
			<value>test2@email</value>
			</destination>
		</recipient>
	</recipients>
</response>

FF240, FF440, or FF840 Example Inbound Routes for Lines 

GET /ffws/v1/routes/lines 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>
		<lines>
		<line>
			<line_number>1</line_number>
			<description>first line</description>
			<destination>
			<type>Email</type>
			<value>cla@mts.test</value>
			</destination>
		</line>
		<line>
			<line_number>2</line_number>
			<description>second line</description>
			<destination>
			<type>Notify</type>	
			<value>test@mts.test</value>
			</destination>
		</line>
	</lines>
</response>

FF240-IP Example Inbound Default Routes 

GET /ffws/v1/routes/lines 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>
	<default>
		<destination>
			<type>User </type>
			<value>admin</value>
		</destination>
	</default>
</response>