updateLinks¶
Request Method: PUT
Description: Update link(s) details
URL: https://api.iovox.com:444/Links?v=3&method=updateLinks
The following parameters must 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 updateLinks request:
<?xml version="1.0" encoding="utf-8"?>
<request>
<link>
<link_id>ext1</link_id>
<new_link_id>ext12</new_link_id>
<link_name>My updated Link Name</link_name>
<link_type>My updated Link Type</link_type>
<click_to_call>1</click_to_call>
<link_date>2008-11-19 14:10:46</link_date>
</link>
<link>
...
</link>
</request>
Payload Description¶
| Node Name | Description | Default Value | Data Type | Mandatory |
| link_id | The Link ID that relates to the link whose details are being updated | STRING | YES | |
| new_link_id | The New Link ID we want to assign to the current link. | STRING | NO | |
| link_name | The new Link Name | STRING | NO | |
| link_type | The new Link Type | STRING | NO | |
| click_to_call | The Click to Call status of the Link (1 = on, 0 = off) | INTEGER | NO | |
| 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 |
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 links to the request |
| 400 | Link ID x of y Empty | Add link_id x (item) of y (total) |
| 400 | Link ID x of y does not exist | Correct link_id x (item) of y (total) |
| 400 | New Link ID x of y already exist | Correct link_id x (item) of y (total) |
| 400 | Link Name x of y Empty | Add link_name for Link x (item) of y (total) or remove empty link_name |
| 400 | Link Name x is already attached to Node | Correct the link_name x which is already attached to the Node |
| 400 | Duplicate Link Name x for Node in the XML | Correct the duplicated link_name x for the node in the XML |
| 400 | Link Type x of y Empty | Add link_type for Link x (item) of y (total) or remove empty link_type |
| 400 | Link Date x of y Invalid | Correct link_date for Node x (item) of y (total) |
| 400 | Click to Call Status x of y Invalid | Correct wrong click_to_call status |
| 500 | Internal Server Error | Retry later |