updateNodes¶
Request Method: PUT
Description: Update node(s) details
URL: https://api.iovox.com:444/Nodes?v=3&method=updateNodes
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 updateNodes request:
<?xml version="1.0" encoding="utf-8"?>
<request>
<node>
<node_id>ext1</node_id>
<new_node_id>ext12</new_node_id>
<node_name>My first updated API node</node_name>
<node_type>My updated Node Type</node_type>
<node_date>2008-11-19 14:10:46</node_date>
</node>
<node>
...
</node>
</request>
Payload Description¶
| Node Name | Description | Default Value | Data Type | Mandatory |
| node_id | Node ID that relates to the node whose details are being updated | STRING | YES | |
| new_node_id | New Node ID for the node we want to update. | STRING | NO | |
| node_name | The new Node Name | STRING | NO | |
| node_type | The new Node Type | STRING | NO | |
| 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. | 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 PUT. x attempted | Switch request method x to PUT |
| 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 x (item) of y (total) |
| 400 | Node ID x of y does not exist | Removed or change node_id x (item) of y (total) |
| 400 | New Node ID x of y already exist | Removed or change new_node_id x (item) of y (total) |
| 400 | Node Name x of y Empty | Add node_name for Node x (item) of y (total) or remove node_name x of y from the XML |
| 400 | Node Type x of y Empty | Add node_type for Node x (item) of y (total) or remove node_type x of y from the XML |
| 400 | Node Date x of y Invalid | Correct node_date for Node x (item) of y (total) |
| 500 | Internal Server Error | Retry later |