POST api/goods/CatalogBrands

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

Request Information

URI Parameters

None.

Body Parameters

CatalogBrandsRequest
NameDescriptionTypeAdditional information
IsMobile

Признак, что запрос идёт из мобильного приложения

boolean

None.

MainPage

Признак, что запрос идёт с главной страницы/экрана

boolean

None.

CatalogId

Идентификатор каталога, по которому нужно вернуть структуру и подструктуру (2 вложенности)

integer

None.

CatalogPositionId

Идентификатор позиции (папки) каталога, по которой нужно вернуть структуру

integer

None.

CatalogPositionName

Наименование позиции (папки) каталога, по которой нужно вернуть структуру

string

None.

Guid

Гуид позиции (папки) каталога, по которой нужно вернуть структуру

string

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",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<CatalogBrandsRequest 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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <CatalogId>1</CatalogId>
  <CatalogPositionId>1</CatalogPositionId>
  <CatalogPositionName>sample string 1</CatalogPositionName>
  <Guid>sample string 2</Guid>
  <IsMobile>true</IsMobile>
  <MainPage>true</MainPage>
</CatalogBrandsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CatalogBrandsResponse
NameDescriptionTypeAdditional information
Brands

Массив брендов

Collection of CatalogBrandsBrand

None.

ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Brands": [
    {
      "Id": 1,
      "BrandId": 1,
      "Name": "sample string 1",
      "Logo": "sample string 2",
      "BigLogo": "sample string 3",
      "Filter": {
        "Id": 1,
        "Name": "sample string 1",
        "Value": "sample string 2",
        "ValueId": 1
      }
    },
    {
      "Id": 1,
      "BrandId": 1,
      "Name": "sample string 1",
      "Logo": "sample string 2",
      "BigLogo": "sample string 3",
      "Filter": {
        "Id": 1,
        "Name": "sample string 1",
        "Value": "sample string 2",
        "ValueId": 1
      }
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<CatalogBrandsResponse 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>
  <Brands>
    <CatalogBrandsResponse.CatalogBrandsBrand>
      <BigLogo>sample string 3</BigLogo>
      <BrandId>1</BrandId>
      <Filter>
        <Id>1</Id>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
        <ValueId>1</ValueId>
      </Filter>
      <Id>1</Id>
      <Logo>sample string 2</Logo>
      <Name>sample string 1</Name>
    </CatalogBrandsResponse.CatalogBrandsBrand>
    <CatalogBrandsResponse.CatalogBrandsBrand>
      <BigLogo>sample string 3</BigLogo>
      <BrandId>1</BrandId>
      <Filter>
        <Id>1</Id>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
        <ValueId>1</ValueId>
      </Filter>
      <Id>1</Id>
      <Logo>sample string 2</Logo>
      <Name>sample string 1</Name>
    </CatalogBrandsResponse.CatalogBrandsBrand>
  </Brands>
</CatalogBrandsResponse>