createLinks¶

Request Method: POST

Description: Create a new link(s)

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

The following parameters can be sent in the querystring

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES
output	Specifying XML or JSON returns data in XML or JSON format	XML	STRING	NO

Payload¶

The following XML payload must be sent with a createLinks request:

<?xml version="1.0" encoding="utf-8"?>
<request>
    <link>
        <node_id>12ABC34</node_id>
        <link_id>1234</link_id>
        <link_name>House Buyer Mag</link_name>
        <link_type>Magazine Advertisement</link_type>
        <link_date>2008-11-19 14:10:46</link_date>
        <click_to_call>1</click_to_call>
    </link>
    <link>
       ...
    <link>
 </request>

Payload Description¶

Node Name	Description	Default Value	Data Type	Mandatory
link > node_id	Node ID to attach the link to		STRING	YES
link > link_id	An ID by which the reference of the link		STRING	YES
link > link_name	Name of the link		STRING	YES
link > link_type	The type of link		STRING	YES
link > link_date	A reference date to be stored alongside the Link. Link date format is YYYY-MM-DD HH:MM:SS with hours, minutes and seconds being optional. Hours, minutes and seconds defaults to 00:00:00.		DATETIME	NO
link > click_to_call	Click to Call status - 1 (on) or 0 (off)	1	INTEGER	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 POST. x attempted	Switch request method x to POST
400	XML Empty	Add xml to the request body
400	XML parse error. x at line y, column z	Correct XML at point x on line y, column z
400	Request Empty	Add at least one link to the request
400	Link ID x of y Empty	Add link_id for Link x (item) of y (total)
400	Link ID x of y already exists	Correct the link_id for Link x (item) of y (total)
400	Link Name x is already attached to Node y	Correct link name x so that it is unique within the links attached to Node y
400	Node ID x of y Empty	Add node_id for link x (item) of y (total)
400	Node ID x of y does not exist	Correct node_id for link x (item) of y (total)
400	Link Name x of y Empty	Add link_name for link x (item) of y (total)
400	Link Type x of y Empty	Add link_type for link x (item) of y (total)
400	Link Date x of y Invalid	Correct link_date for link x (item) of y (total)
400	Click to Call Status x of y Invalid	Correct click_to_call status for link x (item) of y (total)
400	Duplicate Link Name x for Node y in the XML	Correct link name so that it is unique within the links attached to Node y
500	Internal Server Error	Retry later

Success Result¶

HTTP/1.1 201 Created