GET api/product/GetCategoryList

Get list of product categories. Each category contains a list of subcategories, and each subcategory contains a list of pieces.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Category
NameDescriptionTypeAdditional information
CategoryCode

string

None.

CategoryName

string

None.

SubCategoryList

Collection of SubCategory

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CategoryCode": "sample string 1",
    "CategoryName": "sample string 2",
    "SubCategoryList": [
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      },
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      }
    ]
  },
  {
    "CategoryCode": "sample string 1",
    "CategoryName": "sample string 2",
    "SubCategoryList": [
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      },
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterAPI.Products">
  <Category>
    <CategoryCode>sample string 1</CategoryCode>
    <CategoryName>sample string 2</CategoryName>
    <SubCategoryList>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
    </SubCategoryList>
  </Category>
  <Category>
    <CategoryCode>sample string 1</CategoryCode>
    <CategoryName>sample string 2</CategoryName>
    <SubCategoryList>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
    </SubCategoryList>
  </Category>
</ArrayOfCategory>