GET api/ClientApi

Request Information

URI Parameters

Name	Description	Type	Additional information
AgreementCode	Код путевки	string	None.
DateFrom	начало периода	SerializedDateTime	None.
DateTo	окончание периода	SerializedDateTime	None.
PeriodType	тип периода	DateType	None.
NameAndFirstNameSearch	Флаг поиска по имени и фамилии одновременно	boolean	None.
Name	часть фамилии для поиска	string	None.
NameLat	Часть фамилии латиницей	string	None.
FirstName	часть имени для поиска	string	None.
FirstNameLat	Имя латиницей	string	None.
MiddleName	Отчество клиента	string	None.
MiddleNameLat	Отчество клиента латиницей	string	None.
Gender	Пол	TouristGender	None.
CardSerie	Серия дисконтной карты	string	None.
CardNumber	Номер дисконтной карты	string	None.
PerPage	Число элементов на странице	integer	None.
CurrentPage	Номер запрашиваемой страницы	integer	None.
Birthday	Дата рождения клиента	SerializedDateTime	None.
FullConditions	Флаг - "использовать поиск по вхождению"	boolean	None.
RussianPassportSeries	Серия российского паспорта	string	None.
RussianPassportNumber	Номер российского паспорта	string	None.
ForeignPassportSeries	Серия заграничного паспорта	string	None.
ForeignPassportNumber	Номер заграничного паспорта	string	None.
CountriesThatClientWouldVisitIds	Страны, которые клиент хочет посетить (на основании анкетных данных)	Collection of integer	None.
ManagerId	Менеджер клиента	integer	None.
SendEmail	Флаг - "отправлять e-mail"	boolean	None.
SendSms	Флаг - "отправлять SMS"	boolean	None.
IsPhoneKnown	Флаг - "известен номер телефона"	boolean	None.
ClientCountry	Страна клиента	string	None.
ClientArea	Регион клиента	string	None.
ClientCity	Город клиента	string	None.
MobilePhone	Мобильный телефон клиента	string	None.
Phone	Обычный телефон клиента	string	None.
Email	Эл. почта клиента	string	None.
AvailableIds	Массив выбранных клиентов - например, для рассылки	Collection of integer	None.
AddValues	Массив дополнительных полей	Collection of Pair of string [key] and string [value]	None.
AddValuesString	Массив дополнительных полей строкой	Collection of string	None.
FirstAndSecondName	Имя и фамилия клиента	string	None.
CardSeriesAndNumber	Серия и номер дисконтной карты клиента	string	None.
RussianPassportSeriesAndNumber	Серия и номер российского паспорта клиента	string	None.
ForeignPassportSeriesAndNumber	Серия и номер загранпаспорта клиента	string	None.
WithRanking	Флаг ранжинования клиентов. (борьба с дублями клиентов)	boolean	None.
IsImport	Флаг поиска клиентов из импорта, другой вес при поиске дубликатов нужен	boolean	None.
DepartmentRegionIds	фильтр по региону и собсвенно офису	Collection of integer	None.
DepartmentIds		Collection of integer	None.

Body Parameters

None.

Response Information

Resource Description

GetAllClientsResponse

Name	Description	Type	Additional information
Items		Collection of ClientListItemData	None.
SearchInfo		SearchInfo	None.
ExportReport		ReportsItem	None.
LeadsCount		integer	None.
AgreementsCount		integer	None.
ResultQueryInfo	Сообщения	ResultQueryInfoContainer	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "ID": 1,
      "Name": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "NameLat": "sample string 4",
      "FirstNameLat": "sample string 5",
      "MiddleNameLat": "sample string 6",
      "Birthday": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "Age": "sample string 7",
      "PostIndex": "sample string 8",
      "PostCity": "sample string 9",
      "PostStreet": "sample string 10",
      "PostBuilding": "sample string 11",
      "PostFlat": "sample string 12",
      "Phone": "sample string 13",
      "PassportType": "sample string 14",
      "PassportNumber": "sample string 15",
      "PassportDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "PassportDateEnd": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "PassportRusSer": "sample string 16",
      "PassportRusNumber": "sample string 17",
      "PassportRusDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "Code": "sample string 18",
      "Comment": "sample string 19",
      "Email": "sample string 20",
      "Constant": true,
      "CreateDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "ChangeDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "UserID": 22,
      "Mobile_CC": "sample string 23",
      "Mobile_RG": "sample string 24",
      "Mobile_Number": "sample string 25",
      "Gender": "MAN",
      "GenderName": "Мужской",
      "Citizen": "sample string 26",
      "CitizenId": 1,
      "AgeCategory": "ADULT",
      "LeadsCount": 27,
      "AgreementsCount": 28,
      "Address": "sample string 29",
      "RealAddress": "sample string 30",
      "Manager": {
        "CanLogin": true,
        "Code": "sample string 2",
        "DepartmentId": 3,
        "DepartmentName": "sample string 4",
        "Email": "sample string 5",
        "FirstName": "sample string 6",
        "Id": 7,
        "IsNeedPassword": true,
        "IsNewLogin": true,
        "Login": "sample string 10",
        "MiddleName": "sample string 11",
        "Name": "sample string 12",
        "OldLogin": "sample string 13",
        "Password": "sample string 14"
      }
    },
    {
      "ID": 1,
      "Name": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "NameLat": "sample string 4",
      "FirstNameLat": "sample string 5",
      "MiddleNameLat": "sample string 6",
      "Birthday": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "Age": "sample string 7",
      "PostIndex": "sample string 8",
      "PostCity": "sample string 9",
      "PostStreet": "sample string 10",
      "PostBuilding": "sample string 11",
      "PostFlat": "sample string 12",
      "Phone": "sample string 13",
      "PassportType": "sample string 14",
      "PassportNumber": "sample string 15",
      "PassportDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "PassportDateEnd": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "PassportRusSer": "sample string 16",
      "PassportRusNumber": "sample string 17",
      "PassportRusDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "Code": "sample string 18",
      "Comment": "sample string 19",
      "Email": "sample string 20",
      "Constant": true,
      "CreateDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "ChangeDate": {
        "Serialized": "01.01.1970",
        "HasValue": true,
        "Milliseconds": 3,
        "Format": "sample string 4"
      },
      "UserID": 22,
      "Mobile_CC": "sample string 23",
      "Mobile_RG": "sample string 24",
      "Mobile_Number": "sample string 25",
      "Gender": "MAN",
      "GenderName": "Мужской",
      "Citizen": "sample string 26",
      "CitizenId": 1,
      "AgeCategory": "ADULT",
      "LeadsCount": 27,
      "AgreementsCount": 28,
      "Address": "sample string 29",
      "RealAddress": "sample string 30",
      "Manager": {
        "CanLogin": true,
        "Code": "sample string 2",
        "DepartmentId": 3,
        "DepartmentName": "sample string 4",
        "Email": "sample string 5",
        "FirstName": "sample string 6",
        "Id": 7,
        "IsNeedPassword": true,
        "IsNewLogin": true,
        "Login": "sample string 10",
        "MiddleName": "sample string 11",
        "Name": "sample string 12",
        "OldLogin": "sample string 13",
        "Password": "sample string 14"
      }
    }
  ],
  "SearchInfo": {
    "ResultsCount": 1,
    "PageCount": 2
  },
  "ExportReport": {
    "Title": "sample string 1",
    "Name": "sample string 2",
    "Id": 3,
    "WebReportId": 4,
    "TemplateId": "d16ebe34-e147-4793-b8f6-ab34e8e864d3",
    "ReportFormat": "sample string 6",
    "NeedSelectedData": [
      "sample string 1",
      "sample string 2"
    ],
    "NeedScreenFilter": true,
    "Url": "sample string 8",
    "IsAvailableForTourist": true,
    "IsNeedSignedDocument": true,
    "IsShowPrivateCabinet": true
  },
  "LeadsCount": 54,
  "AgreementsCount": 56,
  "RedirectUrl": "sample string 1",
  "ResultQueryInfo": {
    "ResultsCount": 1,
    "HasError": false,
    "Info": [],
    "CacheStorageTimeEnd": true,
    "RefreshPeriod": 0,
    "DelFromCacheDateTime": "2024-11-23T16:53:53.6067072+03:00",
    "UserMessages": "",
    "UserMessagesHtml": ""
  }
}

application/xml, text/xml

Sample:

<GetAllClientsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Client.Contract">
  <RedirectUrl xmlns="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">sample string 1</RedirectUrl>
  <ResultQueryInfo xmlns="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
    <_x003C_DelFromCacheDateTime_x003E_k__BackingField>2024-11-23T16:53:53.6067072+03:00</_x003C_DelFromCacheDateTime_x003E_k__BackingField>
    <_x003C_ResultsCount_x003E_k__BackingField>1</_x003C_ResultsCount_x003E_k__BackingField>
    <info />
  </ResultQueryInfo>
  <ExportReport xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Reports.Contract">
    <d2p1:Id>3</d2p1:Id>
    <d2p1:IsAvailableForTourist>true</d2p1:IsAvailableForTourist>
    <d2p1:IsNeedSignedDocument>true</d2p1:IsNeedSignedDocument>
    <d2p1:IsShowPrivateCabinet>true</d2p1:IsShowPrivateCabinet>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:NeedScreenFilter>true</d2p1:NeedScreenFilter>
    <d2p1:NeedSelectedData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:NeedSelectedData>
    <d2p1:ReportFormat>sample string 6</d2p1:ReportFormat>
    <d2p1:TemplateId>d16ebe34-e147-4793-b8f6-ab34e8e864d3</d2p1:TemplateId>
    <d2p1:Title>sample string 1</d2p1:Title>
    <d2p1:Url>sample string 8</d2p1:Url>
    <d2p1:WebReportId>4</d2p1:WebReportId>
  </ExportReport>
  <Items>
    <ClientListItemData>
      <Address>sample string 29</Address>
      <Age>sample string 7</Age>
      <AgeCategory>ADULT</AgeCategory>
      <AgreementsCount>28</AgreementsCount>
      <Birthday xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </Birthday>
      <ChangeDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </ChangeDate>
      <Citizen>sample string 26</Citizen>
      <CitizenId>1</CitizenId>
      <Code>sample string 18</Code>
      <Comment>sample string 19</Comment>
      <Constant>true</Constant>
      <CreateDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </CreateDate>
      <Email>sample string 20</Email>
      <FirstName>sample string 2</FirstName>
      <FirstNameLat>sample string 5</FirstNameLat>
      <Gender>MAN</Gender>
      <ID>1</ID>
      <LeadsCount>27</LeadsCount>
      <Manager xmlns:d4p1="http://schemas.datacontract.org/2004/07/Megatec.MasterAgent.Entities.Dictionaries">
        <d4p1:CanLogin>true</d4p1:CanLogin>
        <d4p1:Code>sample string 2</d4p1:Code>
        <d4p1:DepartmentId>3</d4p1:DepartmentId>
        <d4p1:DepartmentName>sample string 4</d4p1:DepartmentName>
        <d4p1:Email>sample string 5</d4p1:Email>
        <d4p1:FirstName>sample string 6</d4p1:FirstName>
        <d4p1:Id>7</d4p1:Id>
        <d4p1:IsNeedPassword>true</d4p1:IsNeedPassword>
        <d4p1:IsNewLogin>true</d4p1:IsNewLogin>
        <d4p1:Login>sample string 10</d4p1:Login>
        <d4p1:MiddleName>sample string 11</d4p1:MiddleName>
        <d4p1:Name>sample string 12</d4p1:Name>
        <d4p1:OldLogin>sample string 13</d4p1:OldLogin>
        <d4p1:Password>sample string 14</d4p1:Password>
      </Manager>
      <MiddleName>sample string 3</MiddleName>
      <MiddleNameLat>sample string 6</MiddleNameLat>
      <Mobile_CC>sample string 23</Mobile_CC>
      <Mobile_Number>sample string 25</Mobile_Number>
      <Mobile_RG>sample string 24</Mobile_RG>
      <Name>sample string 1</Name>
      <NameLat>sample string 4</NameLat>
      <PassportDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </PassportDate>
      <PassportDateEnd xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </PassportDateEnd>
      <PassportNumber>sample string 15</PassportNumber>
      <PassportRusDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </PassportRusDate>
      <PassportRusNumber>sample string 17</PassportRusNumber>
      <PassportRusSer>sample string 16</PassportRusSer>
      <PassportType>sample string 14</PassportType>
      <Phone>sample string 13</Phone>
      <PostBuilding>sample string 11</PostBuilding>
      <PostCity>sample string 9</PostCity>
      <PostFlat>sample string 12</PostFlat>
      <PostIndex>sample string 8</PostIndex>
      <PostStreet>sample string 10</PostStreet>
      <RealAddress>sample string 30</RealAddress>
      <UserID>22</UserID>
    </ClientListItemData>
    <ClientListItemData>
      <Address>sample string 29</Address>
      <Age>sample string 7</Age>
      <AgeCategory>ADULT</AgeCategory>
      <AgreementsCount>28</AgreementsCount>
      <Birthday xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </Birthday>
      <ChangeDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </ChangeDate>
      <Citizen>sample string 26</Citizen>
      <CitizenId>1</CitizenId>
      <Code>sample string 18</Code>
      <Comment>sample string 19</Comment>
      <Constant>true</Constant>
      <CreateDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </CreateDate>
      <Email>sample string 20</Email>
      <FirstName>sample string 2</FirstName>
      <FirstNameLat>sample string 5</FirstNameLat>
      <Gender>MAN</Gender>
      <ID>1</ID>
      <LeadsCount>27</LeadsCount>
      <Manager xmlns:d4p1="http://schemas.datacontract.org/2004/07/Megatec.MasterAgent.Entities.Dictionaries">
        <d4p1:CanLogin>true</d4p1:CanLogin>
        <d4p1:Code>sample string 2</d4p1:Code>
        <d4p1:DepartmentId>3</d4p1:DepartmentId>
        <d4p1:DepartmentName>sample string 4</d4p1:DepartmentName>
        <d4p1:Email>sample string 5</d4p1:Email>
        <d4p1:FirstName>sample string 6</d4p1:FirstName>
        <d4p1:Id>7</d4p1:Id>
        <d4p1:IsNeedPassword>true</d4p1:IsNeedPassword>
        <d4p1:IsNewLogin>true</d4p1:IsNewLogin>
        <d4p1:Login>sample string 10</d4p1:Login>
        <d4p1:MiddleName>sample string 11</d4p1:MiddleName>
        <d4p1:Name>sample string 12</d4p1:Name>
        <d4p1:OldLogin>sample string 13</d4p1:OldLogin>
        <d4p1:Password>sample string 14</d4p1:Password>
      </Manager>
      <MiddleName>sample string 3</MiddleName>
      <MiddleNameLat>sample string 6</MiddleNameLat>
      <Mobile_CC>sample string 23</Mobile_CC>
      <Mobile_Number>sample string 25</Mobile_Number>
      <Mobile_RG>sample string 24</Mobile_RG>
      <Name>sample string 1</Name>
      <NameLat>sample string 4</NameLat>
      <PassportDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </PassportDate>
      <PassportDateEnd xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </PassportDateEnd>
      <PassportNumber>sample string 15</PassportNumber>
      <PassportRusDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models.Common.Contract">
        <d4p1:_format>sample string 4</d4p1:_format>
        <d4p1:_serialized>01.01.1970</d4p1:_serialized>
        <d4p1:_value>1970-01-01T03:00:00.003+03:00</d4p1:_value>
      </PassportRusDate>
      <PassportRusNumber>sample string 17</PassportRusNumber>
      <PassportRusSer>sample string 16</PassportRusSer>
      <PassportType>sample string 14</PassportType>
      <Phone>sample string 13</Phone>
      <PostBuilding>sample string 11</PostBuilding>
      <PostCity>sample string 9</PostCity>
      <PostFlat>sample string 12</PostFlat>
      <PostIndex>sample string 8</PostIndex>
      <PostStreet>sample string 10</PostStreet>
      <RealAddress>sample string 30</RealAddress>
      <UserID>22</UserID>
    </ClientListItemData>
  </Items>
  <SearchInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mag.TourGate.TourGateWebClient.Models">
    <d2p1:PageCount>2</d2p1:PageCount>
    <d2p1:ResultsCount>1</d2p1:ResultsCount>
  </SearchInfo>
</GetAllClientsResponse>