POST api/goods/CatalogPositionListAction

Добавление, изменение, получение информации о позициях каталога в списке позиций каталога, с пагинацией и фильтрами

Request Information

URI Parameters

None.

Body Parameters

CatalogPositionListActionRequest
NameDescriptionTypeAdditional information
Name

Наименование списка(для Create и Update)

 string

None.
ActionType

Тип действия, которое необходимо произвести (Create, Update, Info, Delete)

 string

None.
Active

Признак активации списка (для Update)

 boolean

None.
NoActive

Признак деактивации списка (для Update)

 boolean

None.
PositionList

Массив идентификаторов

 Collection of CatalogPositionListActionPositionListRow

None.
CatalogPositionListId

Идентификатор списка который будут менять или в котором будут произодить изменения (для Update, Delete, Info)

 integer

None.
Start

Пагинация: от какой записи возвращать данные, включая указанную (для Info c detail = 1)

 integer

None.
Length

Пагинация: количество записей, которые нужно вернуть (для Info c detail = 1)

 integer

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "ActionType": "sample string 2",
  "Active": true,
  "NoActive": true,
  "PositionList": [
    {
      "Id": 1,
      "CatalogPositionId": 1
    },
    {
      "Id": 1,
      "CatalogPositionId": 1
    }
  ],
  "CatalogPositionListId": 1,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample: 
<CatalogPositionListActionRequest 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>
  <ActionType>sample string 2</ActionType>
  <Active>true</Active>
  <CatalogPositionListId>1</CatalogPositionListId>
  <Length>1</Length>
  <Name>sample string 1</Name>
  <NoActive>true</NoActive>
  <PositionList>
    <CatalogPositionListActionRequest.CatalogPositionListActionPositionListRow>
      <CatalogPositionId>1</CatalogPositionId>
      <Id>1</Id>
    </CatalogPositionListActionRequest.CatalogPositionListActionPositionListRow>
    <CatalogPositionListActionRequest.CatalogPositionListActionPositionListRow>
      <CatalogPositionId>1</CatalogPositionId>
      <Id>1</Id>
    </CatalogPositionListActionRequest.CatalogPositionListActionPositionListRow>
  </PositionList>
  <Start>1</Start>
</CatalogPositionListActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CatalogPositionListActionResponse
NameDescriptionTypeAdditional information
CatalogPositionList

Идентификатор созданного списка (для Create)

 integer

None.
CountPosition

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

 integer

None.
PositionListName

Наименование списка (для Info)

 string

None.
ProcTime

Дата и время создания списка (для Info)

 date

None.
PositionNoActive

Статус активности списка с точки зрения отображения в ЛК (для Info)

 boolean

None.
TotalRows

Количество записей всего (для Info c detail = 1)

 integer

None.
TotalRowsSelect

Количество записей в запросе (для Info c detail = 1)

 integer

None.
Data

Массив позиций

 Collection of CatalogPositionListActionDataRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CatalogPositionList": 1,
  "CountPosition": 1,
  "PositionListName": "sample string 1",
  "ProcTime": "2025-01-13T14:23:11.240278+03:00",
  "PositionNoActive": true,
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "CatalogPositionId": 1,
      "PositionName": "sample string 1"
    },
    {
      "Id": 1,
      "CatalogPositionId": 1,
      "PositionName": "sample string 1"
    }
  ],
  "ErrorCode": 2,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample: 
<CatalogPositionListActionResponse 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">2</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</Message>
  <CatalogPositionList>1</CatalogPositionList>
  <CountPosition>1</CountPosition>
  <Data>
    <CatalogPositionListActionResponse.CatalogPositionListActionDataRow>
      <CatalogPositionId>1</CatalogPositionId>
      <Id>1</Id>
      <PositionName>sample string 1</PositionName>
    </CatalogPositionListActionResponse.CatalogPositionListActionDataRow>
    <CatalogPositionListActionResponse.CatalogPositionListActionDataRow>
      <CatalogPositionId>1</CatalogPositionId>
      <Id>1</Id>
      <PositionName>sample string 1</PositionName>
    </CatalogPositionListActionResponse.CatalogPositionListActionDataRow>
  </Data>
  <PositionListName>sample string 1</PositionListName>
  <PositionNoActive>true</PositionNoActive>
  <ProcTime>2025-01-13T14:23:11.240278+03:00</ProcTime>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</CatalogPositionListActionResponse>