GET api/CategoryProducts/SpecificCategory/{id}

Return a batch of CategoryProduct class objects for a specific category.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Eskimo ID of the category to return results for

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsCategoryProduct
NameDescriptionTypeAdditional information
eskimo_product_identifier

The Eskimo Identifier of the Product

string

Required

eskimo_category_id

The Eskimo Category ID

string

Required

web_category_id

The Primary Key of the Category as used by the website. These are set using the UpdateCartIDs POST action in the Category controller.

string

String length: inclusive between 0 and 200

web_product_id

The Primary Key of the Product as used by the website. These are set using the UpdateCartIDs POST action in the Products controller.

string

String length: inclusive between 0 and 200

Response Formats

application/json, text/json

Sample:
[
  {
    "eskimo_product_identifier": "sample string 1",
    "eskimo_category_id": "sample string 2",
    "web_category_id": "sample string 3",
    "web_product_id": "sample string 4"
  },
  {
    "eskimo_product_identifier": "sample string 1",
    "eskimo_category_id": "sample string 2",
    "web_category_id": "sample string 3",
    "web_product_id": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfclsCategoryProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsCategoryProduct>
    <eskimo_category_id>sample string 2</eskimo_category_id>
    <eskimo_product_identifier>sample string 1</eskimo_product_identifier>
    <web_category_id>sample string 3</web_category_id>
    <web_product_id>sample string 4</web_product_id>
  </clsCategoryProduct>
  <clsCategoryProduct>
    <eskimo_category_id>sample string 2</eskimo_category_id>
    <eskimo_product_identifier>sample string 1</eskimo_product_identifier>
    <web_category_id>sample string 3</web_category_id>
    <web_product_id>sample string 4</web_product_id>
  </clsCategoryProduct>
</ArrayOfclsCategoryProduct>