POST api/pos/PoslistAction

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

Request Information

URI Parameters

None.

Body Parameters

PoslistActionRequest
NameDescriptionTypeAdditional information
Name

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

string

None.

ActionType

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

string

None.

Active

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

boolean

None.

NoActive

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

boolean

None.

PartnerPos

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

Collection of PoslistActionPartnerPosStr

None.

PosListId

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

integer

None.

Detail

Признак, что нужно вернуть селект с детализацией по точкам

boolean

None.

City

Входной фильтр: идентификатор города в списке точек (для Info c detail = 1)

integer

None.

Partner

Входной фильтр: идентификатор партнера в списке точек (для Info c detail = 1)

integer

None.

Pos

Входной фильтр: идентификатор точки в списке точек (для Info c detail = 1)

integer

None.

CityName

Входной фильтр: наименование города (для Info c detail = 1)

string

None.

PosName

Входной фильтр: наименование точки (для Info c detail = 1)

string

None.

PartnerName

Входной фильтр: наименование партнера (для Info c detail = 1)

string

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,
  "PartnerPos": [
    {
      "Id": 1,
      "Pos": 1,
      "Partner": 1
    },
    {
      "Id": 1,
      "Pos": 1,
      "Partner": 1
    }
  ],
  "PosListId": 1,
  "Detail": true,
  "City": 1,
  "Partner": 1,
  "Pos": 1,
  "CityName": "sample string 3",
  "PosName": "sample string 4",
  "PartnerName": "sample string 5",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 6"
}

application/xml, text/xml

Sample:
<PoslistActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request">
  <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 6</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <Active>true</Active>
  <City>1</City>
  <CityName>sample string 3</CityName>
  <Detail>true</Detail>
  <Length>1</Length>
  <Name>sample string 1</Name>
  <NoActive>true</NoActive>
  <Partner>1</Partner>
  <PartnerName>sample string 5</PartnerName>
  <PartnerPos>
    <PoslistActionRequest.PoslistActionPartnerPosStr>
      <Id>1</Id>
      <Partner>1</Partner>
      <Pos>1</Pos>
    </PoslistActionRequest.PoslistActionPartnerPosStr>
    <PoslistActionRequest.PoslistActionPartnerPosStr>
      <Id>1</Id>
      <Partner>1</Partner>
      <Pos>1</Pos>
    </PoslistActionRequest.PoslistActionPartnerPosStr>
  </PartnerPos>
  <Pos>1</Pos>
  <PosListId>1</PosListId>
  <PosName>sample string 4</PosName>
  <Start>1</Start>
</PoslistActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PoslistActionResponse
NameDescriptionTypeAdditional information
PosList

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

integer

None.

CountPos

Количество точек продаж в списке

integer

None.

Caption

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

string

None.

ProcTime

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

date

None.

PosListActive

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

boolean

None.

TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

Poses

Массив точек продаж

Collection of PoslistActionPosesStr

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "PosList": 1,
  "CountPos": 1,
  "Caption": "sample string 1",
  "ProcTime": "2024-06-16T13:12:35.0701554+03:00",
  "PosListActive": true,
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Poses": [
    {
      "Id": 1,
      "Pos": 1,
      "PosName": "sample string 1",
      "Address": "sample string 2",
      "City": 1,
      "CityName": "sample string 3",
      "Partner": 1,
      "PartnerName": "sample string 4"
    },
    {
      "Id": 1,
      "Pos": 1,
      "PosName": "sample string 1",
      "Address": "sample string 2",
      "City": 1,
      "CityName": "sample string 3",
      "Partner": 1,
      "PartnerName": "sample string 4"
    }
  ],
  "ErrorCode": 2,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<PoslistActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response">
  <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>
  <Caption>sample string 1</Caption>
  <CountPos>1</CountPos>
  <PosList>1</PosList>
  <PosListActive>true</PosListActive>
  <Poses>
    <PoslistActionResponse.PoslistActionPosesStr>
      <Address>sample string 2</Address>
      <City>1</City>
      <CityName>sample string 3</CityName>
      <Id>1</Id>
      <Partner>1</Partner>
      <PartnerName>sample string 4</PartnerName>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
    </PoslistActionResponse.PoslistActionPosesStr>
    <PoslistActionResponse.PoslistActionPosesStr>
      <Address>sample string 2</Address>
      <City>1</City>
      <CityName>sample string 3</CityName>
      <Id>1</Id>
      <Partner>1</Partner>
      <PartnerName>sample string 4</PartnerName>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
    </PoslistActionResponse.PoslistActionPosesStr>
  </Poses>
  <ProcTime>2024-06-16T13:12:35.0701554+03:00</ProcTime>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</PoslistActionResponse>