removeCategoryFromLink

Request Method: PUT

Description: Removes the specified attached Category from a link

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

The following parameters can be sent in the querystring

ParameterDescriptionDefault ValueData TypeMandatory
vAPI version to use
INTEGERYES

Payload

The following XML payload must be sent with an removeCategoryFromLink request:

<?xml version="1.0" encoding="utf-8"?>
<request>
     <link>
         <link_id>333</link_id>
         <category_id>123</category_id>
         <label>Business Category</label>
     </link>
     <link>
         <link_id>333</link_id>
         <category_id>124</category_id>
         <label>Customer Type</label>
     </link>
     <link>
         <link_id>444</link_id>
         <category_id>230</category_id>
         <label>Location</label>
     </link>
 </request>

Payload Description

Node NameDescriptionDefault ValueData TypeMandatory
link_id  The Link ID to remove the category from
STRINGYES
category_idThe ID of the category to be removed. Retrievable by the Categories method getCategoryID
STRINGYES
labelThe label of the category to be removed
STRINGYES

Result

Error Result

HTTP CodeError StringResolution
400API Version EmptyAdd a value for the v parameter in the query string
400API Version InvalidCorrect v parameter
400Request Method must be PUT. x attemptedSwitch request method x to PUT
400XML EmptyAdd xml to the request body
400XML parse error. x at line y, column zCorrect XML at point x on line y, column z
400Request EmptyAdd at least one link_id to the request
400Link ID x of y EmptyCorrect link_id x (item) of y (total)
400Link ID x of y does not existCorrect link_id x (item) of y (total)
400Category ID x of y EmptyAdd category_id x (item) of y (total)
400Category ID x of y not an integerCorrect category_id x (item) of y (total)
400Label x of y EmptyCorrect label x (item) of y (total)
400Category ID/Label Combination x of y does not existCorrect category_id and label combination x (item) of y (total)
400Category ID/Label Combination x of y not attached to Link ID zCorrect or remove category_id and label combination x (item) of y (total)
500Internal Server ErrorRetry later

Success Result

HTTP/1.1 204 No Content