POST api/ExternalCategories/SpecificID

Retrieves a singular external category class for a specific ID and Type

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.ExternalCategoriesArguments

Name	Description	Type	Additional information
ID	The Category ID	string	None.
Source	The site that is supplying the category information.	EskimoClassLibraries.clsListing+ListingTypeEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "Source": 1
}

application/xml, text/xml

Sample:

<ExternalCategoriesArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <ID>sample string 1</ID>
  <Source>eBay</Source>
</ExternalCategoriesArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EskimoClassLibraries.clsExternalCategory

Name	Description	Type	Additional information
CategoryID	The unique identifier of the category	string	Required String length: inclusive between 0 and 50
CategoryLevel	Top level categories will be 1, then beneath these, child categories will be 2, 3 and so on.	integer	None.
CategoryParentID	The unique identifier of the parent category. Pass NULL for top-level categories.	string	None.
CategorySource	The site that the category is used on	EskimoClassLibraries.clsListing+ListingTypeEnum	None.
CategoryName	The name of the Category	string	None.
ItemSpecifics	A collection of key-value pairs allowing the list of products returned to be filtered efficiently. For example, if the category is a Jumpers, eBay may have a Property called Material, with possible values of Sheep Wool, Cashmere, Cotton and Linen.	Collection of EskimoClassLibraries.clsItemSpecifics	None.
LeafCategory		boolean	None.
AdditionalIdentifier	Optional. Further ID for the category, if required.	string	String length: inclusive between 0 and 200

Response Formats

application/json, text/json

Sample:

{
  "CategoryID": "sample string 1",
  "CategoryLevel": 2,
  "CategoryParentID": "sample string 3",
  "CategorySource": 1,
  "CategoryName": "sample string 4",
  "ItemSpecifics": [
    {
      "MinSelected": 1,
      "MaxSelected": 2,
      "SelectionMode": 1,
      "ValueType": null,
      "SpecificsName": "sample string 3",
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "MinSelected": 1,
      "MaxSelected": 2,
      "SelectionMode": 1,
      "ValueType": null,
      "SpecificsName": "sample string 3",
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "LeafCategory": true,
  "AdditionalIdentifier": "sample string 6"
}

application/xml, text/xml

Sample:

<clsExternalCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <AdditionalIdentifier>sample string 6</AdditionalIdentifier>
  <CategoryID>sample string 1</CategoryID>
  <CategoryLevel>2</CategoryLevel>
  <CategoryName>sample string 4</CategoryName>
  <CategoryParentID>sample string 3</CategoryParentID>
  <CategorySource>eBay</CategorySource>
  <ItemSpecifics>
    <clsItemSpecifics>
      <SpecificsName>sample string 3</SpecificsName>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Values>
      <MaxSelected>2</MaxSelected>
      <MinSelected>1</MinSelected>
      <SelectionMode>SelectionOnly</SelectionMode>
      <ValueType i:nil="true" />
    </clsItemSpecifics>
    <clsItemSpecifics>
      <SpecificsName>sample string 3</SpecificsName>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Values>
      <MaxSelected>2</MaxSelected>
      <MinSelected>1</MinSelected>
      <SelectionMode>SelectionOnly</SelectionMode>
      <ValueType i:nil="true" />
    </clsItemSpecifics>
  </ItemSpecifics>
  <LeafCategory>true</LeafCategory>
</clsExternalCategory>