createCategoryConfigurations¶

Request Method: POST

Description: Create categories configurations.

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

The following parameters can be sent in the querystring

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES

Payload:¶

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

<?xml version="1.0" encoding="utf-8"?>
<request>
    <category>
        <label>Location</label>
        <category_id>Location</category_id>
        <type>Tree</type>
    </category>
</request>

<?xml version="1.0" encoding="utf-8"?>
<request>
    <category>
        <label>Quarantine Date</label>
        <category_id>Quarantine Date</category_id>
        <type>Quarantine_Date</type>
    </category>
</request>

Payload Description¶

Node Name	Description	Default Value	Data Type	Mandatory
category	Tag which involve all the category configuration details			YES
category>category_id	ID of the category configuration		STRING	YES
category>label	The label for the category configuration		STRING	YES
category>type	The type of category configuration it will be. Currently there are the following types: Tree with multiple level string categories, Quarantine_Date with a date with a valid format YYYY-MM-DD and Deletion_Date with a date with a valid format. These two last types will be explained in the page	Tree	STRING	NO
category>colour	The colour in valid hexadecimal format		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 POST. x attempted	Switch request method x to POST
400	XML Empty	Add xml to the request body
400	XML parse error. x at line y, column z	Correct XML at point x on line y, column z
400	Request Empty	Add at least one node to the request
400	Category ID x of y Empty	Add Category ID for Category x (item) of y (total)
400	Category ID x of y exists	Correct the Category ID for Category x (item) of y (total)
400	Label x of y Empty	Add label for Category x (item) of y (total)
400	Label x of y exists	Correct label for Category x (item) of y (total)
400	Type x of y invalid	Correct the type for Category x (item) of y (total)
400	Type x of y invalid	Correct the type for Category x (item) of y (total)
400	Colour x of y invalid	Correct the colour for Category x (item) of y (total)
500	Internal Server Error	Retry later

Success Result¶

Includes Node/Link IDs generated by any AUTOINCREMENT() and any VoxNumbers attached to the Links

HTTP/1.1 201 Created