API Endpoint
https://api.xure.co/v1/lookup/taxonomy/configuration

Obtains the configuration settings to use when displaying a category picker control

Get Category Picker Configuration GET

Gets lists of categories to be shown as root, shortcuts or hidden by the picker

Parameters

Request Parameters
ParameterDescription
Configuration StringReference to the category configuration to returnRequired
Response Parameters
ParameterDescription
RootTerms ListA list of the pre-defined taxonomy root terms to display in the initial category picker viewOptional
Name String
The name of the category
Identifier String
The unique identifier assigned to this category
Shortcuts ListA list of the pre-defined taxonomy shortcuts to display in the initial category picker viewOptional
Name String
The name of the category
Description String
A description to be shown alongside the shortcutOptional
Identifier String
The unique identifier assigned to this category
Flagged ListA list of terms to flag when shown in the category pickerOptional
Identifier String
The unique identifier assigned to this category
Hidden ListA list of the terms that should never be shown by the category pickerOptional
Identifier String
The unique identifier assigned to this category

XML

Example Request 
GET https://api.xure.co/v1/lookup/taxonomy/configuration.eb?Configuration=String 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="CategoryConfigurationResponse">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="RootTerms" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>A list of the pre-defined taxonomy root terms to display in the initial category picker view</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="Shortcuts" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>A list of the pre-defined taxonomy shortcuts to display in the initial category picker view</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="Description" minOccurs="0" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>A description to be shown alongside the shortcut</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="Flagged" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>A list of terms to flag when shown in the category picker</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <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="Hidden" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>A list of the terms that should never be shown by the category picker</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <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: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"?>
<CategoryConfigurationResponse>
  <RootTerms>
    <Item>
      <Name>xsd:string</Name>
      <Identifier>xsd:string</Identifier>
    </Item>...</RootTerms>
  <Shortcuts>
    <Item>
      <Name>xsd:string</Name>
      <Description>xsd:string</Description>
      <Identifier>xsd:string</Identifier>
    </Item>...</Shortcuts>
  <Flagged>
    <Item>
      <Identifier>xsd:string</Identifier>
    </Item>...</Flagged>
  <Hidden>
    <Item>
      <Identifier>xsd:string</Identifier>
    </Item>...</Hidden>
</CategoryConfigurationResponse>

JSON

Example Request 
GET https://api.xure.co/v1/lookup/taxonomy/configuration.eb?Configuration=String HTTP/1.1
Accept: application/json
Example Response 
HTTP/1.1 200 OK
Content-Type: application/json

{"RootTerms":[{"Name":String,
      "Identifier":String},
    ...],
  "Shortcuts":[{"Name":String,
      "Description":String,
      "Identifier":String},
    ...],
  "Flagged":[{"Identifier":String},
    ...],
  "Hidden":[{"Identifier":String},
    ...]}

Status Codes

Status and Error Codes
HTTP StatusError Code and Description
400

DataError:Configuration:RequiredRule

A configuration reference is required

Test

Reference to the category configuration to return