getCategories

Request Method: GET

Description: Returns a list of child categories depends on a parent category id. This is useful for retrieving a group of categories which belogs to  a parent category, such as to assign/remove a category to/from a link, retrieve a list of subcategories.

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

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
req_fieldsComma separated list of abbreviated fields to return in response. cid=Category id, cl= Category Label, cv= Category Value,chc = Child Count (This Field must be with any of the previous requied fields)cid,cl,cv,chcSTRINGNO
parent_category_idReturns all child  categories for the specified category ID
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 5000Correct the limit parameter
400Category ID does not existChange parent_category_id to an existing Category ID
400Required Fields Invalid: field1Change field1 for any of the Required Fields allowed
400Child Count not allow to be alone in the Required FieldsAdd any of the other Required Fields allowed. Child Count is not allow to be alone in the Required Fields
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>4<total_pages>
     <total_results>100<total_results>
     <results>
         <result>
             <category_id>100</category_id>
             <label>LOCATION</label>
             <value>LONDON</value>
             <child_count>6</child_count>
         <result>
     <results>
 <response>