POST api/goods/CatalogStructure

Получение структуры каталога по его идентификатору или структуры папки каталога по её гуиду, идентификатору или наименованию

Request Information

URI Parameters

None.

Body Parameters

CatalogStructureRequest

Name	Description	Type	Additional information
IsMobile	Признак, что запрос идёт из мобильного приложения	boolean	None.
MainPage	Признак, что нужна структура каталога для главного экрана/страницы	boolean	None.
CatalogId	Идентификатор каталога, по которому нужно вернуть структуру и подструктуру (2 вложенности)	integer	None.
CatalogPositionId	Идентификатор позиции (папки) каталога, по которой нужно вернуть структуру	integer	None.
CatalogPositionName	Наименование позиции (папки) каталога, по которой нужно вернуть структуру	string	None.
Guid	Гуид позиции (папки) каталога, по которой нужно вернуть структуру	string	None.
BrandName	Фильтр: наименование бренда, каталог которого нужно вернуть	string	None.
BrandId	Идентификатор бренда товара	integer	None.
UpLevel	Признак, что нужно вернуть верхнеуровневую структуру (т.е. те позиции, у которых нет "родителя")	boolean	None.
NoActive	Входной фильтр: только неактивные позиции каталога	boolean	None.
Active	Входной фильтр: только активные позиции каталога	boolean	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "IsMobile": true,
  "MainPage": true,
  "CatalogId": 1,
  "CatalogPositionId": 1,
  "CatalogPositionName": "sample string 1",
  "Guid": "sample string 2",
  "BrandName": "sample string 3",
  "BrandId": 1,
  "UpLevel": true,
  "NoActive": true,
  "Active": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:

<CatalogStructureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.GoodsRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Active>true</Active>
  <BrandId>1</BrandId>
  <BrandName>sample string 3</BrandName>
  <CatalogId>1</CatalogId>
  <CatalogPositionId>1</CatalogPositionId>
  <CatalogPositionName>sample string 1</CatalogPositionName>
  <Guid>sample string 2</Guid>
  <IsMobile>true</IsMobile>
  <MainPage>true</MainPage>
  <NoActive>true</NoActive>
  <UpLevel>true</UpLevel>
</CatalogStructureRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CatalogStructureResponse

Name	Description	Type	Additional information
Positions	Массив позиций	Collection of CatalogStructurePosition	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Positions": [
    {
      "Id": 1,
      "PositionId": 1,
      "Guid": "sample string 1",
      "Name": "sample string 2",
      "IconLogo": "sample string 3",
      "PreviewImage": "sample string 4",
      "LevelShown": 64,
      "NoActive": true,
      "NoShownMobile": true,
      "SubPositions": [
        {
          "Id": 1,
          "PositionId": 1,
          "Guid": "sample string 1",
          "Name": "sample string 2",
          "IconLogo": "sample string 3",
          "PreviewImage": "sample string 4",
          "LastPosition": true,
          "LevelShown": 64,
          "NoActive": true,
          "NoShownMobile": true
        },
        {
          "Id": 1,
          "PositionId": 1,
          "Guid": "sample string 1",
          "Name": "sample string 2",
          "IconLogo": "sample string 3",
          "PreviewImage": "sample string 4",
          "LastPosition": true,
          "LevelShown": 64,
          "NoActive": true,
          "NoShownMobile": true
        }
      ]
    },
    {
      "Id": 1,
      "PositionId": 1,
      "Guid": "sample string 1",
      "Name": "sample string 2",
      "IconLogo": "sample string 3",
      "PreviewImage": "sample string 4",
      "LevelShown": 64,
      "NoActive": true,
      "NoShownMobile": true,
      "SubPositions": [
        {
          "Id": 1,
          "PositionId": 1,
          "Guid": "sample string 1",
          "Name": "sample string 2",
          "IconLogo": "sample string 3",
          "PreviewImage": "sample string 4",
          "LastPosition": true,
          "LevelShown": 64,
          "NoActive": true,
          "NoShownMobile": true
        },
        {
          "Id": 1,
          "PositionId": 1,
          "Guid": "sample string 1",
          "Name": "sample string 2",
          "IconLogo": "sample string 3",
          "PreviewImage": "sample string 4",
          "LastPosition": true,
          "LevelShown": 64,
          "NoActive": true,
          "NoShownMobile": true
        }
      ]
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<CatalogStructureResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.GoodsResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <Positions>
    <CatalogStructureResponse.CatalogStructurePosition>
      <Guid>sample string 1</Guid>
      <IconLogo>sample string 3</IconLogo>
      <Id>1</Id>
      <LevelShown>64</LevelShown>
      <Name>sample string 2</Name>
      <NoActive>true</NoActive>
      <NoShownMobile>true</NoShownMobile>
      <PositionId>1</PositionId>
      <PreviewImage>sample string 4</PreviewImage>
      <SubPositions>
        <GoodSCatalogSystemDataResponse>
          <Guid>sample string 1</Guid>
          <IconLogo>sample string 3</IconLogo>
          <Id>1</Id>
          <LastPosition>true</LastPosition>
          <LevelShown>64</LevelShown>
          <Name>sample string 2</Name>
          <NoActive>true</NoActive>
          <NoShownMobile>true</NoShownMobile>
          <PositionId>1</PositionId>
          <PreviewImage>sample string 4</PreviewImage>
        </GoodSCatalogSystemDataResponse>
        <GoodSCatalogSystemDataResponse>
          <Guid>sample string 1</Guid>
          <IconLogo>sample string 3</IconLogo>
          <Id>1</Id>
          <LastPosition>true</LastPosition>
          <LevelShown>64</LevelShown>
          <Name>sample string 2</Name>
          <NoActive>true</NoActive>
          <NoShownMobile>true</NoShownMobile>
          <PositionId>1</PositionId>
          <PreviewImage>sample string 4</PreviewImage>
        </GoodSCatalogSystemDataResponse>
      </SubPositions>
    </CatalogStructureResponse.CatalogStructurePosition>
    <CatalogStructureResponse.CatalogStructurePosition>
      <Guid>sample string 1</Guid>
      <IconLogo>sample string 3</IconLogo>
      <Id>1</Id>
      <LevelShown>64</LevelShown>
      <Name>sample string 2</Name>
      <NoActive>true</NoActive>
      <NoShownMobile>true</NoShownMobile>
      <PositionId>1</PositionId>
      <PreviewImage>sample string 4</PreviewImage>
      <SubPositions>
        <GoodSCatalogSystemDataResponse>
          <Guid>sample string 1</Guid>
          <IconLogo>sample string 3</IconLogo>
          <Id>1</Id>
          <LastPosition>true</LastPosition>
          <LevelShown>64</LevelShown>
          <Name>sample string 2</Name>
          <NoActive>true</NoActive>
          <NoShownMobile>true</NoShownMobile>
          <PositionId>1</PositionId>
          <PreviewImage>sample string 4</PreviewImage>
        </GoodSCatalogSystemDataResponse>
        <GoodSCatalogSystemDataResponse>
          <Guid>sample string 1</Guid>
          <IconLogo>sample string 3</IconLogo>
          <Id>1</Id>
          <LastPosition>true</LastPosition>
          <LevelShown>64</LevelShown>
          <Name>sample string 2</Name>
          <NoActive>true</NoActive>
          <NoShownMobile>true</NoShownMobile>
          <PositionId>1</PositionId>
          <PreviewImage>sample string 4</PreviewImage>
        </GoodSCatalogSystemDataResponse>
      </SubPositions>
    </CatalogStructureResponse.CatalogStructurePosition>
  </Positions>
</CatalogStructureResponse>