createNodes¶
Request Method: POST
Description: Create a new node(s)
URL: https://api.iovox.com:444/Nodes?v=3&method=createNodes
The following parameters can be sent in the querystring
Parameter | Description | Default Value | Data Type | Mandatory |
v | API version to use | INTEGER | YES |
Payload¶
The following XML payload must be sent with an createNodes request:
<?xml version="1.0" encoding="utf-8"?>
<request>
<node>
<node_id>Westbourne Apartments</node_id>
<node_name>150 Westbourne Grove</node_name>
<node_type>Property</node_type>
<node_date>2008-11-19 14:10:46</node_date>
</node>
<node>
<node_id>Tyler's Hairdressers</node_id>
<node_name>71 Upper Walthamstow Road</node_name>
<node_type>Business</node_type>
<node_date>2008-11-19 14:10:46</node_date>
</node>
</request>
Payload Description¶
The following parameters can be sent in the querystring
Node Name | Description | Default Value | Data Type | Mandatory |
node > node_id | Node ID to identify the Node by | STRING | YES | |
node > node_name | Name of the Node | STRING | YES | |
node > node_type | The type of Node | STRING | YES | |
node > node_date | A reference date to be stored alongside the Node. Node 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. | CURRENT DATE | DATETIME | 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 node to the request |
400 | Node ID x of y Empty | Add node_id for Node x (item) of y (total) |
400 | Node ID x of y already exists | Removed or change node_id x (item) of y (total) |
400 | Node Name x of y Empty | Add node_name for Node x (item) of y (total) |
400 | Node Type x of y Empty | Add node_type for Node x (item) of y (total) |
400 | Node Date x of y Invalid | Correct node_date for Node x (item) of y (total) |
400 | Duplicate Node ID Received | Change node_id to be unique |
500 | Internal Server Error | Retry later |