POST api/system/TransferDataInfo

Получение идентификаторов добавленных или измененных сущностей, за период, с фильтрами

Request Information

URI Parameters

None.

Body Parameters

TransferDataInfoRequest
NameDescriptionTypeAdditional information
MaxTransferId

Фильтр: записи больше максимального, заданного идентификатора, который ранее был обработан

integer

None.

Type

Фильтр: записи по конкретной сущности

string

None.

Today

Фильтр: записи за сегодня

boolean

None.

Yesterday

Фильтр: записи за вчера

boolean

None.

DaysAgo

Фильтр: количество дней "назад", за которое, исключая сегодняшний, нужно вернуть данные

byte

None.

Start

Фильтр: позиция с которой возвращать данные

integer

None.

Length

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MaxTransferId": 1,
  "Type": "sample string 1",
  "Today": true,
  "Yesterday": true,
  "DaysAgo": 64,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<TransferDataInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SystemRequest">
  <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 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <DaysAgo>64</DaysAgo>
  <Length>1</Length>
  <MaxTransferId>1</MaxTransferId>
  <Start>1</Start>
  <Today>true</Today>
  <Type>sample string 1</Type>
  <Yesterday>true</Yesterday>
</TransferDataInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TransferDataInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Общее количество позиций, которые возможно вернуть с учётом указанных фильтров

integer

None.

TransferData

Массив данных с идентификаторами, ключами и значениями нужными для внешнего сервиса

Collection of TransferDataInfoTransferDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TransferData": [
    {
      "Id": 1,
      "TransferId": 1,
      "ActionType": "sample string 1",
      "Type": "sample string 2",
      "Client": 1,
      "Cheque": 1,
      "Order": 1,
      "Invoice": 1,
      "Coupon": "sample string 3",
      "SertCard": 1,
      "SertCardOwner": 1,
      "SertCardOrders": 1,
      "SourceId": 1,
      "SourceName": "sample string 4",
      "DateAction": "2024-04-26T14:37:42.3424024+03:00",
      "ServiceRegistration": 1
    },
    {
      "Id": 1,
      "TransferId": 1,
      "ActionType": "sample string 1",
      "Type": "sample string 2",
      "Client": 1,
      "Cheque": 1,
      "Order": 1,
      "Invoice": 1,
      "Coupon": "sample string 3",
      "SertCard": 1,
      "SertCardOwner": 1,
      "SertCardOrders": 1,
      "SourceId": 1,
      "SourceName": "sample string 4",
      "DateAction": "2024-04-26T14:37:42.3424024+03:00",
      "ServiceRegistration": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<TransferDataInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SystemResponse">
  <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>
  <TotalRows>1</TotalRows>
  <TransferData>
    <TransferDataInfoResponse.TransferDataInfoTransferDataRow>
      <ActionType>sample string 1</ActionType>
      <Cheque>1</Cheque>
      <Client>1</Client>
      <Coupon>sample string 3</Coupon>
      <DateAction>2024-04-26T14:37:42.3424024+03:00</DateAction>
      <Id>1</Id>
      <Invoice>1</Invoice>
      <Order>1</Order>
      <SertCard>1</SertCard>
      <SertCardOrders>1</SertCardOrders>
      <SertCardOwner>1</SertCardOwner>
      <ServiceRegistration>1</ServiceRegistration>
      <SourceId>1</SourceId>
      <SourceName>sample string 4</SourceName>
      <TransferId>1</TransferId>
      <Type>sample string 2</Type>
    </TransferDataInfoResponse.TransferDataInfoTransferDataRow>
    <TransferDataInfoResponse.TransferDataInfoTransferDataRow>
      <ActionType>sample string 1</ActionType>
      <Cheque>1</Cheque>
      <Client>1</Client>
      <Coupon>sample string 3</Coupon>
      <DateAction>2024-04-26T14:37:42.3424024+03:00</DateAction>
      <Id>1</Id>
      <Invoice>1</Invoice>
      <Order>1</Order>
      <SertCard>1</SertCard>
      <SertCardOrders>1</SertCardOrders>
      <SertCardOwner>1</SertCardOwner>
      <ServiceRegistration>1</ServiceRegistration>
      <SourceId>1</SourceId>
      <SourceName>sample string 4</SourceName>
      <TransferId>1</TransferId>
      <Type>sample string 2</Type>
    </TransferDataInfoResponse.TransferDataInfoTransferDataRow>
  </TransferData>
</TransferDataInfoResponse>