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
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 |
label | The label of the category | STRING | YES | |
value | The value of the leaf to return the path for | STRING | YES | |
delimiter | The delimiter to use in the category_path | ; | 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 20000 | Correct the limit parameter |
400 | Label Empty | Add label to the Request |
400 | Value Empty | Add value to the Request |
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>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>