POST api/tradeOutlets/{id}/subscribers

Метод для получения информации о "подписчиках" торговой точки с указанием фильтров.

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/tradeOutlets/{id}/subscribers?api-version=2.0

  Для этого метода требуется авторизация

Информация о запросе

URL параметры

НазваниеОписаниеТип данныхДополнительная информация
id

Уникальный идентификатор "Торговой точки"

 string

Required
Fields

Список дополнительных полей, которые необходимо вернуть

 string

Нет
Sort

Поле по которому необходима сортировка результатов

 string

Нет
Page

Номер страницы (начиная с 1)

 integer

Интервал: с 1 по 2147483646
PageSize

Кол-во записей на странице (макс. 50)

 integer

Интервал: с 1 по 50

Тело запроса

Список фильтров

TradeOutletSubscribersFilterModel
НазваниеОписаниеТип данныхДополнительная информация
Roles

Collection of string

Нет
RelationshipIds

Collection of string

Нет

Форматы запросов

{
  "roles": [
    "sample string 1",
    "sample string 2"
  ],
  "relationshipIds": [
    "sample string 1",
    "sample string 2"
  ]
}

<TradeOutletSubscribersFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V2.TradeOutlets">
  <RelationshipIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RelationshipIds>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Roles>
</TradeOutletSubscribersFilterModel>

Sample not available.

Информация об ответе

PagedResponseModelOfUserModel
НазваниеОписаниеТип данныхДополнительная информация
Data

Collection of UserModel

Нет
Pagination

PaginationModel

Нет

Форматы ответа

{
  "data": [
    {
      "id": "cf79dc75-c8fc-4d14-97ac-026744b954f2",
      "vendorId": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "middleName": "sample string 5",
      "fullName": "sample string 6",
      "imageUrl": "sample string 7",
      "email": "sample string 8",
      "emailConfirmed": true,
      "phoneNumber": "sample string 10",
      "phoneNumberConfirmed": true,
      "twoFactorEnabled": true,
      "lockoutEndDateUtc": "2024-10-06T19:21:33.7333864Z",
      "lockoutEnabled": true,
      "roles": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "id": "cf79dc75-c8fc-4d14-97ac-026744b954f2",
      "vendorId": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "middleName": "sample string 5",
      "fullName": "sample string 6",
      "imageUrl": "sample string 7",
      "email": "sample string 8",
      "emailConfirmed": true,
      "phoneNumber": "sample string 10",
      "phoneNumberConfirmed": true,
      "twoFactorEnabled": true,
      "lockoutEndDateUtc": "2024-10-06T19:21:33.7333864Z",
      "lockoutEnabled": true,
      "roles": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 2,
    "totalCount": 3,
    "totalPages": 4,
    "prevPageLink": "sample string 5",
    "nextPageLink": "sample string 6"
  }
}

<PagedResponseModelOfUserModelDQePuQkZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Miscellaneous.Pagination">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Users">
    <d2p1:UserModel>
      <d2p1:Email>sample string 8</d2p1:Email>
      <d2p1:EmailConfirmed>true</d2p1:EmailConfirmed>
      <d2p1:FirstName>sample string 3</d2p1:FirstName>
      <d2p1:FullName>sample string 6</d2p1:FullName>
      <d2p1:Id>cf79dc75-c8fc-4d14-97ac-026744b954f2</d2p1:Id>
      <d2p1:ImageUrl>sample string 7</d2p1:ImageUrl>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:LockoutEnabled>true</d2p1:LockoutEnabled>
      <d2p1:LockoutEndDateUtc>2024-10-06T19:21:33.7333864+00:00</d2p1:LockoutEndDateUtc>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
      <d2p1:PhoneNumberConfirmed>true</d2p1:PhoneNumberConfirmed>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Roles>
      <d2p1:TwoFactorEnabled>true</d2p1:TwoFactorEnabled>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:UserModel>
    <d2p1:UserModel>
      <d2p1:Email>sample string 8</d2p1:Email>
      <d2p1:EmailConfirmed>true</d2p1:EmailConfirmed>
      <d2p1:FirstName>sample string 3</d2p1:FirstName>
      <d2p1:FullName>sample string 6</d2p1:FullName>
      <d2p1:Id>cf79dc75-c8fc-4d14-97ac-026744b954f2</d2p1:Id>
      <d2p1:ImageUrl>sample string 7</d2p1:ImageUrl>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:LockoutEnabled>true</d2p1:LockoutEnabled>
      <d2p1:LockoutEndDateUtc>2024-10-06T19:21:33.7333864+00:00</d2p1:LockoutEndDateUtc>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
      <d2p1:PhoneNumberConfirmed>true</d2p1:PhoneNumberConfirmed>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Roles>
      <d2p1:TwoFactorEnabled>true</d2p1:TwoFactorEnabled>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:UserModel>
  </Data>
  <Pagination>
    <NextPageLink>sample string 6</NextPageLink>
    <Page>1</Page>
    <PageSize>2</PageSize>
    <PrevPageLink>sample string 5</PrevPageLink>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Pagination>
</PagedResponseModelOfUserModelDQePuQkZ>