GET api/categories/search/{languageCode}/{filter}?countryCode={countryCode} Authentication required
Use this method to search for any type of category, using a term-based filter. This will return any type of category matching the input filter in the specified language
Request
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
languageCode |
Language represented by its ISO 639-1 Code (2 chars long) |
string |
Required |
filter |
Term used to search categories in the specified language (min. 3 chars long) |
string |
Required |
countryCode |
[Optional] Country represented by its ISO 3166-1 alpha-2 Code (2 chars long). Provide this to search for Local codes |
string |
Default value is |
Response
Returns any type of category having its description in the specified language matching the specified filter
Output : object (See Model)Ouput Sample
{
"infobel": [
{
"code": "017116",
"name": "Restaurants",
"type": "Infobel",
"level": 0
}
],
"international": [
{
"code": "0831",
"name": "Forest products",
"type": "International",
"level": 0
}
],
"local": [
{
"code": "5610A",
"name": "Restauration traditionnelle",
"type": "Local",
"level": 0
}
]
}
<CategorySearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AltInternational i:nil="true" />
<Infobel>
<Category>
<Code>017116</Code>
<CountryCode i:nil="true" />
<Language i:nil="true" />
<Level>0</Level>
<Name>Restaurants</Name>
<ParentCode i:nil="true" />
<Type>Infobel</Type>
</Category>
</Infobel>
<International>
<Category>
<Code>0831</Code>
<CountryCode i:nil="true" />
<Language i:nil="true" />
<Level>0</Level>
<Name>Forest products</Name>
<ParentCode i:nil="true" />
<Type>International</Type>
</Category>
</International>
<Local>
<Category>
<Code>5610A</Code>
<CountryCode i:nil="true" />
<Language i:nil="true" />
<Level>0</Level>
<Name>Restauration traditionnelle</Name>
<ParentCode i:nil="true" />
<Type>Local</Type>
</Category>
</Local>
</CategorySearchResult>