Get Category Details GET
Returns details of the requested category, including the wider terms within which it is included and its immediate narrower terms.
Wider terms are more general representations of this category, whilst narrower terms are more specific.
Request Parameters
| Parameter | Description |
| Configuration String | The taxonomy configuration settings to use to filter results returned. If not given, no filtering will be applied. |
| Strict Boolean | Applies strict filtering to only return terms explicitly allowed by the taxonomy configuration |
Response Parameters
| Parameter | Description |
| CategoryName String | The name of this category |
| CategoryDescription String | Description of products that are covered by this categoryOptional |
| WiderTerms List | List of parent categories, representing more general terms for this categoryOptional |
Name String
| The name of the category |
Identifier String
| The unique identifier assigned to this category |
| NarrowerTerms List | List of immediate children, representing more specific terms for this categoryOptional |
Name String
| The name of the category |
Identifier String
| The unique identifier assigned to this category |
| AlternateTerms List | List of alternate terms that may be used to refer to this categoryOptional |
Name String
| The name of the category |
Example Request
GET https://api.xure.co/v1/lookup/taxonomy/{category}.eb?Configuration=String&Strict=Boolean HTTP/1.1
Accept: text/xml
Response Schema
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="Category">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="CategoryName" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of this category</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="CategoryDescription" minOccurs="0" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Description of products that are covered by this category</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="WiderTerms" minOccurs="0">
<xsd:annotation>
<xsd:documentation>List of parent categories, representing more general terms for this category</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the category</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Identifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The unique identifier assigned to this category</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="NarrowerTerms" minOccurs="0">
<xsd:annotation>
<xsd:documentation>List of immediate children, representing more specific terms for this category</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the category</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Identifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The unique identifier assigned to this category</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="AlternateTerms" minOccurs="0">
<xsd:annotation>
<xsd:documentation>List of alternate terms that may be used to refer to this category</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the category</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml
<?xml version="1.0" encoding="utf-8"?>
<Category>
<CategoryName>xsd:string</CategoryName>
<CategoryDescription>xsd:string</CategoryDescription>
<WiderTerms>
<Item>
<Name>xsd:string</Name>
<Identifier>xsd:string</Identifier>
</Item>...</WiderTerms>
<NarrowerTerms>
<Item>
<Name>xsd:string</Name>
<Identifier>xsd:string</Identifier>
</Item>...</NarrowerTerms>
<AlternateTerms>
<Item>
<Name>xsd:string</Name>
</Item>...</AlternateTerms>
</Category>
Example Request
GET https://api.xure.co/v1/lookup/taxonomy/{category}.eb?Configuration=String&Strict=Boolean HTTP/1.1
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{"CategoryName":String,
"CategoryDescription":String,
"WiderTerms":[{"Name":String,
"Identifier":String},
...],
"NarrowerTerms":[{"Name":String,
"Identifier":String},
...],
"AlternateTerms":[{"Name":String},
...]}