POST api/goods/CatalogBrands

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

Request Information

URI Parameters

None.

Body Parameters

CatalogBrandsRequest
NameDescriptionTypeAdditional information
CatalogId

Идентификатор каталога

 integer

None.
IsMobile

Входной фильтр: источник запроса моб. приложение

 boolean

None.
MainPage

Входной фильтр: запрашиваются бренды для гл. экрана/страницы (приложения или crm)

 boolean

None.
IsCrm

Входной фильтр: источник запроса crm.loycon.ru

 boolean

None.
BrandName

Входной фильтр: наименование бренда (поиск через like)

 string

None.
NoShownMobile

Входной фильтр: вернуть бренды, которые НЕ отображаются в моб. приложении и товары, которых не отображаются в моб. приложении

 boolean

None.
ShownMobile

Входной фильтр: вернуть бренды, которые НЕ отображаются в моб. приложении и товары, которых не отображаются в моб. приложении

 boolean

None.
CatalogPositionId

Входной фильтр: идентификатор позиции (папки) каталога, бренды товаров которой нужно вернуть

 integer

None.
CatalogPositionName

Входной фильтр: наименование папки каталога; альтернатива @catalogposition_id (пока не исользуется)

 string

None.
Guid

Входной фильтр: гуид позиции (папки) каталога (альтернатива @catalogposition_id (пока не исользуется)

 string

None.
NoActive

Входной фильтр: вернуть НЕактивные бренды

 boolean

None.
Active

Входной фильтр: вернуть активные бренды

 boolean

None.
Start

Пагинация: от какой записи возвращать данные, включая указанную

 integer

None.
Length

Пагинация: количество записей, которые нужно вернуть

 integer

None.
Operator

Идентификатор оператора программы лояльности

 integer

None.
Token

Токен пользователя, который инициирует данный запрос

 integer

None.
SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CatalogId": 1,
  "IsMobile": true,
  "MainPage": true,
  "IsCrm": true,
  "BrandName": "sample string 1",
  "NoShownMobile": true,
  "ShownMobile": true,
  "CatalogPositionId": 1,
  "CatalogPositionName": "sample string 2",
  "Guid": "sample string 3",
  "NoActive": true,
  "Active": true,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

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 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Active>true</Active>
  <BrandName>sample string 1</BrandName>
  <CatalogId>1</CatalogId>
  <CatalogPositionId>1</CatalogPositionId>
  <CatalogPositionName>sample string 2</CatalogPositionName>
  <Guid>sample string 3</Guid>
  <IsCrm>true</IsCrm>
  <IsMobile>true</IsMobile>
  <Length>1</Length>
  <MainPage>true</MainPage>
  <NoActive>true</NoActive>
  <NoShownMobile>true</NoShownMobile>
  <ShownMobile>true</ShownMobile>
  <Start>1</Start>
</CatalogBrandsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CatalogBrandsResponse
NameDescriptionTypeAdditional information
TotalRows

Количество записей всего

 integer

None.
TotalRowsSelect

Количество записей в запросе

 integer

None.
Brands

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

 Collection of CatalogBrandsBrand

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Brands": [
    {
      "Id": 1,
      "BrandId": 1,
      "Name": "sample string 1",
      "Logo": "sample string 2",
      "BigLogo": "sample string 3",
      "NoActive": true,
      "NoShownMobile": true,
      "MainPage": true,
      "LevelShown": 64,
      "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",
      "NoActive": true,
      "NoShownMobile": true,
      "MainPage": true,
      "LevelShown": 64,
      "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>
      <LevelShown>64</LevelShown>
      <Logo>sample string 2</Logo>
      <MainPage>true</MainPage>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <NoShownMobile>true</NoShownMobile>
    </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>
      <LevelShown>64</LevelShown>
      <Logo>sample string 2</Logo>
      <MainPage>true</MainPage>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <NoShownMobile>true</NoShownMobile>
    </CatalogBrandsResponse.CatalogBrandsBrand>
  </Brands>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</CatalogBrandsResponse>