getCategoryId

Request Method: GET

Description: Returns a list of matches for the specified category label and value with a full category path and the category ID returned with each match. This is useful for retrieving a category ID for functions that require one, such as to assign/remove a category to/from a link, when the category ID is unknown

URL: https://api.iovox.com:444/Categories?v=3&method=getCategoryId

The following parameters can be sent in the querystring

ParameterDescriptionDefault ValueData TypeMandatory
vAPI version to use
INTEGERYES
pageThe page number to return. Use together with limit to achieve paginated results1INTEGERNO
limitDetermines how many results to return. Use together with page to achieve paginated results. Maximum here is 2000020000INTEGERNO
labelThe label of the category
STRINGYES
valueThe value of the leaf to return the path for
STRINGYES
delimiterThe delimiter to use in the category_path;STRINGNO
outputSpecifying XML or JSON returns data in XML or JSON formatXMLSTRINGNO

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 GET. x attemptedSwitch request method x to GET
400Page Number not an integerRemove non-numerics from page
400Limit not an integerRemove non-numerics from limit
400Limit must be between 1 and 20000Correct the limit parameter
400Label EmptyAdd label to the Request
400Value EmptyAdd value to the Request
400Output Type InvalidCorrect output parameter
500Internal Server ErrorRetry later

Success Result

<?xml version="1.0" encoding="utf-8"?>
<response>
    <current_page>1</current_page>
     <total_pages>1</total_pages>
     <total_results>2</total_results><results>
     <result>
         <category_id>4521</category_id>
         <category_path>Location;United Kingdom;South East;London;Mayfair</category_path>
     </result>
     <result>
         <category_id>6800</category_id>
         <category_path>Location;Another Country;Another Region;Another City;Mayfair</category_path>
     </result>
 </response>