getCategories()
This methods makes possible to search banner categories in abracadaban. This method could be used to display category id, category name, language id and parent category id.
Authentication
This method does not require authentication.
Encoding
The Abracadaban API requires all data to be UTF-8 encoded. More information about UTF-8 encoding
| Argument |
Type |
Valid Values |
Default Value |
Detail |
| api_key |
string |
valid values |
required |
you need a valid api key to use the API |
| language_id |
Int |
|
1 |
|
Returned Values
| Element (path) |
Name |
Type |
Description |
| /[n]/ |
totalRecords |
int |
total number of records found during search |
| /[n]/ |
categoryId |
int |
category unique ID |
| /[n]/ |
category |
string |
category name |
| /[n]/ |
parentCategoryId |
int |
parent category unique id |
Example Query
| |
<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>getCategories()</methodName>
<params>
<param>
<value><string>YOUR_API_KEY</string></value>
</param>
<param>
<value><int>1</int></value>
</param>
</params>
</methodCall>
|
|
|
Example Response
| |
|
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>0</name>
<value>
<struct>
<member>
<name>TotalRecords</name>
<value><int>11</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>1</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>6</int></value>
</member>
<member>
<name>category</name>
<value><string>Abstract</string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>2</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>5</int></value>
</member>
<member>
<name>category</name>
<value><string>Food & Drink</string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>3</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>3</int></value>
</member>
<member>
<name>category</name>
<value><string>Fauna & Flora</string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>4</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>4</int></value>
</member>
<member>
<name>category</name>
<value><string>Landscape</string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>5</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>7</int></value>
</member>
<member>
<name>category</name>
<value><string>Architecture </string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>6</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>8</int></value>
</member>
<member>
<name>category</name>
<value><string>Objects </string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>7</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>9</int></value>
</member>
<member>
<name>category</name>
<value><string>sport</string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>8</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>10</int></value>
</member>
<member>
<name>category</name>
<value><string>Others </string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>9</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>11</int></value>
</member>
<member>
<name>category</name>
<value><string>People </string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>10</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>12</int></value>
</member>
<member>
<name>category</name>
<value><string>Transportation</string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
<member>
<name>11</name>
<value>
<struct>
<member>
<name>categoryId</name>
<value><int>13</int></value>
</member>
<member>
<name>category</name>
<value><string>Background & Texture </string></value>
</member>
<member>
<name>parentCategoryId</name>
<value><int>0</int></value>
</member>
</struct>
</value>
</member>
</struct>
<value>
<param>
<params>
</methodResponse>
|
Error Codes
- 1025: API Key Missing
- You might have forgot to enter API Key.
- 1001: Invalid API Key.
- The API key passed is not valid or has expired.
- 1023: Categories not available.
- The category is not available for this API Key.
