POST api/v2/contact/{searchString}/find

Получение по поисковой строке списка контактов для отправки

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

GET параметры

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

string

Required

Body параметры

FindOrgNameFilter
НазваниеОписаниеТипДополнительная информация
ListAddressBookEntryState

Массив AddressBookEntryState

Нет.

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

application/json, text/json

Пример:
{
  "ListAddressBookEntryState": [
    0,
    0
  ]
}

application/xml, text/xml

Пример:
<FindOrgNameFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Taxnet.Transcrypt.Api20.AddressBook">
  <ListAddressBookEntryState>
    <AddressBookEntryState>None</AddressBookEntryState>
    <AddressBookEntryState>None</AddressBookEntryState>
  </ListAddressBookEntryState>
</FindOrgNameFilter>

application/x-www-form-urlencoded

Пример:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FindOrgNameFilter'.

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

Информация о ресурсах

Массив ContactInfo
НазваниеОписаниеТипДополнительная информация
DocflowMemberId

Идентификатор участника документооборота

string

Нет.

Name

Имя получателя

string

Нет.

IsEnergy

Признак Татэнергосбыта

boolean

Нет.

DepartmentId

Идентификатор департамента

globally unique identifier

Нет.

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

application/json, text/json

Пример:
[
  {
    "DocflowMemberId": "sample string 1",
    "Name": "sample string 2",
    "IsEnergy": true,
    "DepartmentId": "e528b1ca-ff29-46ad-a408-cb1cf710cbc9"
  },
  {
    "DocflowMemberId": "sample string 1",
    "Name": "sample string 2",
    "IsEnergy": true,
    "DepartmentId": "e528b1ca-ff29-46ad-a408-cb1cf710cbc9"
  }
]

application/xml, text/xml

Пример:
<ArrayOfContactInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Taxnet.Transcrypt.Api20.Models">
  <ContactInfo>
    <DepartmentId>e528b1ca-ff29-46ad-a408-cb1cf710cbc9</DepartmentId>
    <DocflowMemberId>sample string 1</DocflowMemberId>
    <IsEnergy>true</IsEnergy>
    <Name>sample string 2</Name>
  </ContactInfo>
  <ContactInfo>
    <DepartmentId>e528b1ca-ff29-46ad-a408-cb1cf710cbc9</DepartmentId>
    <DocflowMemberId>sample string 1</DocflowMemberId>
    <IsEnergy>true</IsEnergy>
    <Name>sample string 2</Name>
  </ContactInfo>
</ArrayOfContactInfo>