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

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES
page	The page number to return. Use together with limit to achieve paginated results	1	INTEGER	NO
limit	Determines how many results to return. Use together with page to achieve paginated results. Maximum here is 20000	20000	INTEGER	NO
req_fields	Comma 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,chc	STRING	NO
parent_category_id	Returns all child categories for the specified category ID		STRING	NO
output	Specifying XML or JSON returns data in XML or JSON format	XML	STRING	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 GET. x attempted	Switch request method x to GET
400	Page Number not an integer	Remove non-numerics from page
400	Limit not an integer	Remove non-numerics from limit
400	Limit must be between 1 and 5000	Correct the limit parameter
400	Category ID does not exist	Change parent_category_id to an existing Category ID
400	Required Fields Invalid: field1	Change field1 for any of the Required Fields allowed
400	Child Count not allow to be alone in the Required Fields	Add any of the other Required Fields allowed. Child Count is not allow to be alone in the Required Fields
400	Output Type Invalid	Correct output parameter
500	Internal Server Error	Retry 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>