getLinks¶

Request Method: GET

Description: Retrieves a list of all Links

URL: https://api.iovox.com:444/Links?v=3&method=getLinks

The following parameters can be sent in the querystring:

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES
page	The page number to return. Use together with limit to achieve paginated results	1	INTEGER	NO
limit	Determines how many results to return. Use together with page to achieve paginated results. Maximum here is 20000	20000	INTEGER	NO
node_id	Returns all links for the specified Node ID		STRING	NO
node_type	Returns all links for the specified Node Type		STRING	NO
link_id	Returns the link for the specified Link ID		STRING	NO
link_type	Returns all links for the specified Link Type		STRING	NO
req_fields	Comma separated list of abbreviated fields to return in response. nid=Node id, nn= Node Name, nt= Node Type, lid = Link Id, ln = Link Name, lt = Link Type,vn = VoxNumber, rn = Rule Name.		STRING	NO
order	Determines which field to order the output result by. Use a field name from the req_fields list and suffix with ASC or DESC for ascending or descending respectively. For example, "nn_DESC" will return results ordered by order_date with the most recent first		STRING	NO
output	Specifying XML or JSON returns data in XML or JSON format	XML	STRING	NO

Result¶

Error Result¶

HTTP Code	Error String	Resolution
400	API Version Empty	Add a value for the v parameter in the query string
400	API Version Invalid	Correct v parameter
400	Request Method must be GET. x attempted	Switch request method x to GET
400	Page Number not an integer	Remove non-numerics from page
400	Limit not an integer	Remove non-numerics from limit
400	Limit must be between 1 and 20000	Correct the limit parameter
400	Required Fields Invalid: fieldone,fieldtwo	Correct or remove fieldone and fieldtwo
400	Order Field Invalid	Check the allowed abbreviation fields in the documentation
400	Order Direction Invalid	Correct the direction in the order.
400	Node ID does not exist	Correct node_id parameter
400	There is no Category with the Category ID x	Correct cat_ids parameter
400	Output Type Invalid	Correct output parameter
500	Internal Server Error	Retry later

Success Result¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <current_page>1</current_page>
  <total_pages>1</total_pages>
  <total_results>1</total_results>
  <results>
    <result>
      <node_id>123</node_id>
      <node_name>Magazine Ad</node_name>
      <node_type>Magazine</node_type>
      <link_id>456</link_id>
      <link_name>Clear Signs</link_name>
      <link_type>Street Sign</link_type>
      <click_to_call>0</click_to_call>
      <voxnumber>448452650033</voxnumber>
      <rule_name>Call</rule_name>
    </result>
  </results>
</response>