helpcenter/helpcenter.r7-office.ru/Web/Bin/ASC.Api.CRM.xml

2749 lines
202 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
2019-02-13 12:12:23 +00:00
<doc>
<assembly>
<name>ASC.Api.CRM</name>
</assembly>
<members>
<member name="M:ASC.Api.CRM.CRMApi.GetCurrencyRates">
<summary>Получить список курсов обмена валют</summary>
<short>Получить список курсов валют</short>
<category>Общие</category>
<returns>Список курсов валют</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCurrencyRate(System.Int32)">
<summary>Узнать курс валюты по ИД</summary>
<short>Узнать курс валюты</short>
<category>Общие</category>
<returns>Курс валюты</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCurrencyRate(System.String,System.String)">
<summary>Узнать курс обмена определенных валют</summary>
<short>Узнать курс валюты</short>
<category>Общие</category>
<returns>Курс валюты</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateCurrencyRate(System.String,System.String,System.Decimal)">
<summary>Создать новый объект курса валюты</summary>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Общие</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCurrencyRate(System.Int32,System.String,System.String,System.Decimal)">
<summary>Обновить объект курса валюты</summary>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Общие</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetCurrencyRates(System.String,System.Collections.Generic.List{ASC.CRM.Core.CurrencyRate})">
<summary>Задать курсы валют</summary>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Общие</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddCurrencyRates(System.Collections.Generic.List{ASC.CRM.Core.CurrencyRate})">
<summary>Добавить курсы валют</summary>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Общие</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteCurrencyRate(System.Int32)">
<summary>Удалить объект курса валюты</summary>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Общие</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceByID(System.Int32)">
<summary>Возвращает подробные сведения о счете с указанным в запросе ИД</summary>
<param name="invoiceid">ИД счета</param>
<short>Получить счет по ИД</short>
<category>Счета</category>
<returns>Счет</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceSample">
<summary>Возвращает подробные сведения о примере счета</summary>
<short>Получить пример счета</short>
<category>Счета</category>
<returns>Счет</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceJsonData(System.Int32)">
<summary>Возвращает данные JSON для счета с указанным в запросе ИД</summary>
<param name="invoiceid">ИД счета</param>
<short>Получить данные JSON для счета</short>
<category>Счета</category>
<returns>Данные JSON</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoices(System.Nullable{ASC.CRM.Core.InvoiceStatus},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,System.Int32,System.String)">
<summary>Возвращает список счетов, соответствующих указанным в запросе критериям</summary>
<param name="status">Статус счета</param>
<param name="issueDateFrom">Начальная дата выставления счета</param>
<param name="issueDateTo">Конечная дата выставления счета</param>
<param name="dueDateFrom">Начальная дата оплаты счета</param>
<param name="dueDateTo">Конечная дата оплаты счета</param>
<param name="entityType">Тип сущности счета</param>
<param name="entityid">ИД сущности счета</param>
<param name="currency" remark="Allowed values: EUR, RUB etc. You can get the whole list of available currencies by api">Валюта счета</param>
<short>Получить список счетов</short>
<category>Счета</category>
<returns>Список счетов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetEntityInvoices(System.String,System.Int32)">
<summary>Возвращает список всех связанных с сущностью счетов с указанными в запросе ИД и типом</summary>
<param name="entityType">Тип сущности счета</param>
<param name="entityid">ИД сущности счета</param>
<short>Получить счета сущности</short>
<category>Счета</category>
<returns>Список счетов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateInvoiceBatchStatus(System.Int32[],ASC.CRM.Core.InvoiceStatus)">
<summary>Обновляет статус счетов с указанными в запросе ИД</summary>
<param name="invoiceids">Список ИД счетов</param>
<param name="status">Статус</param>
<short>Обновить статус группы счетов</short>
<category>Счета</category>
<returns>Пара ключ-значение для счетов и позиций счета</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteInvoice(System.Int32)">
<summary>Удалить счет с указанным в запросе ИД</summary>
<param name="invoiceid">ИД счета</param>
<short>Удалить счет</short>
<category>Счета</category>
<returns>Счет</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchInvoices(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Удаляет группу счетов с указанными в запросе ИД</summary>
<param name="invoiceids">Список ИД счетов</param>
<short>Удалить группу счетов</short>
<category>Счета</category>
<returns>Список счетов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateInvoice(System.String,ASC.Specific.ApiDateTime,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,ASC.Specific.ApiDateTime,System.String,System.String,System.Decimal,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{ASC.CRM.Core.Entities.InvoiceLine})">
<summary>Создает счет с указанными в запросе параметрами (contactId, consigneeId и т. д.)</summary>
<param optional="false" name="number">Номер счета</param>
<param optional="false" name="issueDate">Дата выставления счета</param>
<param optional="true" name="templateType">Тип шаблона счета</param>
<param optional="false" name="contactId">ИД контакта счета</param>
<param optional="true" name="consigneeId">ИД получателя счета</param>
<param optional="true" name="entityId">ИД сущности счета</param>
<param optional="true" name="billingAddressID">ИД адреса выставления счета</param>
<param optional="true" name="deliveryAddressID">ИД адреса доставки счета</param>
<param optional="false" name="dueDate">Дата оплаты счета</param>
<param optional="false" name="language">Язык счета</param>
<param optional="false" name="currency" remark="Allowed values: EUR, RUB etc. You can get the whole list of available currencies by api">Валюта счета</param>
<param optional="false" name="exchangeRate">Курс обмена счета</param>
<param optional="true" name="purchaseOrderNumber">Номер заказа на покупку в счете</param>
<param optional="false" name="terms">Условия счета</param>
<param optional="true" name="description">Описание счета</param>
<param optional="false" name="invoiceLines">Список строк счета</param>
<short>Создать счет</short>
<category>Счета</category>
<returns>Счет</returns>
2019-02-13 12:12:23 +00:00
<example>
<![CDATA[
Передача данных в формате application/json:
2019-02-13 12:12:23 +00:00
data: {
number: "invoice000001",
issueDate: "2015-06-01T00:00:00",
contactId: 10,
dueDate: "2025-06-01T00:00:00",
language: "ru-RU",
2019-02-13 12:12:23 +00:00
currency: "rub",
exchangeRate: 54.32,
terms: "Условия для этого счёта",
2019-02-13 12:12:23 +00:00
invoiceLines:
[{
invoiceItemID: 1,
invoiceTax1ID: 1,
invoiceTax2ID: 2,
description: "описание счёта строка 1",
2019-02-13 12:12:23 +00:00
quantity: 100,
price: 7.7,
discount: 25
}]
},
2019-02-13 12:12:23 +00:00
где invoiceItemID, invoiceTax1ID, invoiceTax2ID — ИД реально существующей позиции счета и налогов счета,
contactId — ИД существующего контакта
2019-02-13 12:12:23 +00:00
]]>
</example>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateInvoice(System.Int32,ASC.Specific.ApiDateTime,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,ASC.Specific.ApiDateTime,System.String,System.String,System.Decimal,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{ASC.CRM.Core.Entities.InvoiceLine})">
<summary>Обновляет выбранный счет, изменяя указанные в запросе параметры (contactId, consigneeId и т. д.)</summary>
<param optional="false" name="id">ИД счета</param>
<param optional="false" name="issueDate">Дата выставления счета</param>
<param optional="true" name="templateType">Тип шаблона счета</param>
<param optional="false" name="contactId">ИД контакта счета</param>
<param optional="true" name="consigneeId">ИД получателя счета</param>
<param optional="true" name="entityId">ИД сущности счета</param>
<param optional="true" name="billingAddressID">ИД адреса выставления счета</param>
<param optional="true" name="deliveryAddressID">ИД адреса доставки счета</param>
<param name="dueDate">Дата оплаты счета</param>
<param optional="false" name="language">Язык счета</param>
<param optional="false" name="currency" remark="Allowed values: EUR, RUB etc. You can get the whole list of available currencies by api">Валюта счета</param>
<param optional="false" name="exchangeRate">Курс обмена счета</param>
<param optional="true" name="purchaseOrderNumber">Номер заказа на покупку в счете</param>
<param optional="false" name="terms">Условия счета</param>
<param optional="true" name="description">Описание счета</param>
<param optional="false" name="invoiceLines">Список строк счета</param>
<short>Обновить счет</short>
<category>Счета</category>
<returns>Счет</returns>
2019-02-13 12:12:23 +00:00
<example>
<![CDATA[
Передача данных в формате application/json:
2019-02-13 12:12:23 +00:00
data: {
id: 5,
issueDate: "2015-06-01T00:00:00",
contactId: 10,
dueDate: "2025-06-01T00:00:00",
language: "ru-RU",
2019-02-13 12:12:23 +00:00
currency: "rub",
exchangeRate: 54.32,
terms: "Условия для этого счёта",
2019-02-13 12:12:23 +00:00
invoiceLines:
[{
invoiceItemID: 1,
invoiceTax1ID: 1,
invoiceTax2ID: 2,
description: "описание счёта строка 1",
2019-02-13 12:12:23 +00:00
quantity: 100,
price: 7.7,
discount: 25
}]
},
2019-02-13 12:12:23 +00:00
где invoiceItemID, invoiceTax1ID, invoiceTax2ID — ИД реально существующей позиции счета и налогов счета,
contactId — ИД существующего контакта
2019-02-13 12:12:23 +00:00
]]>
</example>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoicePdfExistOrCreate(System.Int32)">
<summary>Возвращает связанный со счетом файл PDF, ИД которого указан в запросе</summary>
<param name="invoiceid">ИД счета</param>
<short>Получить файл PDF для счета</short>
<category>Счета</category>
<returns>Файл</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceConverterData(System.Int32,System.String,System.String)">
<summary>Возвращает сведения о создании файла PDF для счета</summary>
<param name="invoiceId">ИД счета</param>
<param name="storageUrl">Адрес хранилища</param>
<param name="revisionId">ИД редакции</param>
<short>Проверить файл PDF для счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>ConverterData</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceByNumberExistence(System.String)">
<summary>Возвращает сведения о наличии счета с указанным в запросе номером</summary>
<param name="number">Номер счета</param>
<short>Проверить наличие счета по номеру</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>IsExist</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceByNumber(System.String)">
<summary>Возвращает подробные сведения о счете с указанным в запросе номером</summary>
<param name="number">Номер счета</param>
<short>Получить счет по номеру</short>
<category>Счета</category>
<returns>Счет</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceItems(System.Int32,System.Nullable{System.Boolean})">
<summary>Возвращает список позиций счета, соответствующих указанным в запросе критериям</summary>
<param name="status">Статус</param>
2019-02-13 12:12:23 +00:00
<param optional="true" name="inventoryStock">InventoryStock</param>
<short>Получить список позиций счета</short>
<category>Счета</category>
<returns>Список InvoiceItem</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceItemByID(System.Int32)">
<summary>Возвращает подробные сведения о позиции счета с указанным в запросе ИД</summary>
<param name="invoiceitemid">ИД позиции счета</param>
<short>Узнать о позиции счета по ИД</short>
<category>Счета</category>
<returns>Позиция счета</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateInvoiceLine(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.Int32,System.Decimal,System.Int32)">
<summary>Создает строку счета с указанными в запросе параметрами (invoiceId, invoiceItemId и т. д.)</summary>
<param optional="false" name="invoiceId">ИД счета</param>
<param optional="false" name="invoiceItemId">ИД позиции счета</param>
<param optional="true" name="invoiceTax1Id">ИД первого налога счета</param>
<param optional="true" name="invoiceTax2Id">ИД второго налога счета</param>
<param optional="true" name="sortOrder">Порядок сортировки</param>
<param optional="true" name="description">Описание</param>
<param optional="true" name="quantity">Количество</param>
<param optional="true" name="price">Цена</param>
<param optional="true" name="discount">Скидка</param>
<short>Создать строку счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceLine</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateInvoiceLine(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.Int32,System.Decimal,System.Int32)">
<summary>Обновляет выбранный счет, изменяя указанные в запросе параметры (invoiceId, invoiceItemId и т. д.)</summary>
<param optional="false" name="id">ИД строки</param>
<param optional="false" name="invoiceId">ИД счета</param>
<param optional="false" name="invoiceItemId">ИД позиции счета</param>
<param optional="true" name="invoiceTax1Id">ИД первого налога счета</param>
<param optional="true" name="invoiceTax2Id">ИД второго налога счета</param>
<param optional="true" name="sortOrder">Порядок сортировки</param>
<param optional="true" name="description">Описание</param>
<param optional="true" name="quantity">Количество</param>
<param optional="true" name="price">Цена</param>
<param optional="true" name="discount">Скидка</param>
<short>Обновить строку счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceLine</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteInvoiceLine(System.Int32)">
<summary>Удаляет строку счета с указанным в запросе ИД</summary>
<param optional="false" name="id">ИД строки</param>
<short>Удалить строку счета</short>
<category>Счета</category>
<returns>ИД строки</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateInvoiceItem(System.String,System.String,System.Decimal,System.String,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
<summary>Создает позицию счета с указанными в запросе параметрами (название, описание, цена и т. д.)</summary>
<param optional="false" name="title">Название позиции</param>
<param optional="true" name="description">Описание позиции</param>
<param optional="false" name="price">Цена позиции</param>
<param optional="true" name="sku">Артикул позиции</param>
<param optional="true" name="quantity">Количество позиции</param>
<param optional="true" name="stockQuantity">Количество позиции на складе</param>
<param optional="true" name="trackInventory">Следить за запасом</param>
<param optional="true" name="invoiceTax1id">ИД первого налога счета для позиции</param>
<param optional="true" name="invoiceTax2id">ИД второго налога счета для позиции</param>
<short>Создать позицию счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceItem</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateInvoiceItem(System.Int32,System.String,System.String,System.Decimal,System.String,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
<summary>Обновляет выбранную позицию счета, изменяя указанные в запросе параметры (название, описание, цену и т. д.)</summary>
<param optional="false" name="id">ИД позиции</param>
<param optional="false" name="title">Название позиции</param>
<param optional="true" name="description">Описание позиции</param>
<param optional="false" name="price">Цена позиции</param>
<param optional="true" name="sku">Артикул позиции</param>
<param optional="true" name="quantity">Количество позиции</param>
<param optional="true" name="stockQuantity">Количество позиции на складе</param>
<param optional="true" name="trackInventory">Следить за запасом</param>
<param optional="true" name="invoiceTax1id">ИД первого налога счета для позиции</param>
<param optional="true" name="invoiceTax2id">ИД второго налога счета для позиции</param>
<short>Обновить позицию счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceItem</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteInvoiceItem(System.Int32)">
<summary>Удаляет позицию счета с указанным в запросе ИД</summary>
<param name="id">ИД позиции</param>
<short>Удалить позицию счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceItem</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchItems(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Удаляет группу позиций счета с указанными в запросе ИД</summary>
<param name="ids">Список ИД позиций</param>
<short>Удалить группу позиций счета</short>
<category>Счета</category>
<returns>Список InvoiceItem</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetInvoiceTaxes">
<summary>Возвращает список налогов счета</summary>
<short>Получить список налогов счета</short>
<category>Счета</category>
<returns>Список InvoiceTax</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateInvoiceTax(System.String,System.String,System.Decimal)">
<summary>Создает налог счета с указанными в запросе параметрами (названием, описанием, ставкой)</summary>
<param name="name">Название налога</param>
<param name="description">Описание налога</param>
<param name="rate">Ставка налога</param>
<short>Создать налог счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceTax</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateInvoiceTax(System.Int32,System.String,System.String,System.Decimal)">
<summary>Обновляет выбранный налог счета, изменяя указанные в запросе параметры (название, описание, ставку)</summary>
<param name="id">ИД налога</param>
<param name="name">Название налога</param>
<param name="description">Описание налога</param>
<param name="rate">Ставка налога</param>
<short>Обновить налог счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceTax</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteInvoiceTax(System.Int32)">
<summary>Удалить налог счета с указанным в запросе ИД</summary>
<param name="id">ИД налога</param>
<short>Удалить налог счета</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceTax</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetSettings">
<summary>Получить настройки счета по умолчанию</summary>
<short>Получить настройки счета по умолчанию</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceSetting</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SaveNumberSettings(System.Boolean,System.String,System.String)">
<summary>Сохранить номер счета по умолчанию</summary>
<param name="autogenerated">Генерируется автоматически</param>
<param name="prefix">Префикс</param>
<param name="number">Число</param>
<short>Сохранить номер счета по умолчанию</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceSetting</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SaveTermsSettings(System.String)">
<summary>Сохранить позиции счета по умолчанию</summary>
<param name="terms">Условия</param>
<short>Сохранить позиции счета по умолчанию</short>
<category>Счета</category>
2019-02-13 12:12:23 +00:00
<returns>InvoiceSetting</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetInvoiceCreationDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetInvoiceLastModifedDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CloseCases(System.Int32)">
<summary>Закрыть мероприятие с указанным в запросе ИД</summary>
<short>Закрыть мероприятие</short>
<category>Мероприятия</category>
<param name="caseid" optional="false">ИД мероприятия</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Мероприятие</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.ReOpenCases(System.Int32)">
<summary>Вернуться к мероприятию с указанным в запросе ИД</summary>
<short>Вернуться к мероприятию</short>
<category>Мероприятия</category>
<param name="caseid" optional="false">ИД мероприятия</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Мероприятие</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateCases(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid},System.Boolean)">
<summary>Создает мероприятие с указанными в запросе параметрами</summary>
<short>Создать мероприятие</short>
<param name="title" optional="false">Название мероприятия</param>
<param name="members" optional="true">Участники</param>
<param name="customFieldList" optional="true">Список пользовательских полей</param>
<param name="isPrivate" optional="true">Конфиденциальность мероприятия: конфиденциальное или нет</param>
<param name="accessList" optional="true">Список пользователей, имеющих доступ к мероприятию</param>
<param name="isNotify" optional="true">Уведомить об мероприятии пользователей в списке доступа (accessList)</param>
<returns>Мероприятие</returns>
<category>Мероприятия</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<example>
<![CDATA[
Передача данных в формате application/json:
2019-02-13 12:12:23 +00:00
data: {
title: "Организация выставки",
2019-02-13 12:12:23 +00:00
isPrivate: false,
customFieldList: [{1: "значение для пользовательского поля с ИД = 1"}]
2019-02-13 12:12:23 +00:00
}
]]>
</example>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCases(System.Int32,System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid},System.Boolean)">
<summary>Обновляет выбранное мероприятие, изменяя указанные в запросе параметры</summary>
<short>Обновить мероприятие</short>
<param name="caseid" optional="false">ИД мероприятия</param>
<param name="title" optional="false">Название мероприятия</param>
<param name="members" optional="true">Участники</param>
<param name="customFieldList" optional="true">Список пользовательских полей</param>
<param name="isPrivate" optional="true">Конфиденциальность мероприятия: конфиденциальное или нет</param>
<param name="accessList" optional="true">Список пользователей, имеющих доступ к мероприятию</param>
<param name="isNotify" optional="true">Уведомить об мероприятии пользователей в списке доступа</param>
<category>Мероприятия</category>
<returns>Мероприятие</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<example>
<![CDATA[
Передача данных в формате application/json:
2019-02-13 12:12:23 +00:00
data: {
caseid: 0,
title: "Организация выставки",
2019-02-13 12:12:23 +00:00
isPrivate: false,
customFieldList: [{1: "значение для пользовательского поля с ИД = 1"}]
2019-02-13 12:12:23 +00:00
}
]]>
</example>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToCases(System.Int32,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа к выбранному мероприятию с указанными в запросе параметрами</summary>
<param name="casesid" optional="false">ИД мероприятия</param>
<param name="isPrivate" optional="false">Конфиденциальность мероприятия: конфиденциальное или нет</param>
<param name="accessList" optional="false">Список пользователей, имеющих доступ к мероприятию</param>
<short>Назначить права по отношению к мероприятию</short>
<category>Мероприятия</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Мероприятие</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToBatchCases(System.Collections.Generic.IEnumerable{System.Int32},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа других пользователей к списку мероприятий с указанными в запросе ИД</summary>
<param name="casesid">Список ИД мероприятий</param>
<param name="isPrivate">Конфиденциальность мероприятия: конфиденциальное или нет</param>
<param name="accessList">Список имеющих доступ пользователей</param>
<short>Назначить права доступа к мероприятиям</short>
<category>Мероприятия</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Список мероприятий</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToBatchCases(System.Int32,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа других пользователей к списку всех мероприятий, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="isClosed">Статус мероприятия</param>
<param optional="true" name="tags">Теги</param>
<param name="isPrivate">Конфиденциальность мероприятия: конфиденциальное или нет</param>
<param name="accessList">Список имеющих доступ пользователей</param>
<short>Назначить права доступа к мероприятиям</short>
<category>Мероприятия</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Список мероприятий</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCaseByID(System.Int32)">
<summary>Возвращает подробные сведения об мероприятии с указанным в запросе ИД</summary>
<short>Получить мероприятие по ИД</short>
<category>Мероприятия</category>
<param name="caseid">ИД мероприятия</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCases(System.Int32,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String})">
<summary>Возвращает список всех мероприятий, соответствующих указанным в запросе параметрам</summary>
<short>Получить список мероприятий</short>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="isClosed">Статус мероприятия</param>
<param optional="true" name="tags">Теги</param>
<category>Мероприятия</category>
<returns>Список мероприятий</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteCase(System.Int32)">
<summary>Удаляет мероприятие с указанным в запросе ИД</summary>
<short>Удалить мероприятие</short>
<param name="caseid">ИД мероприятия</param>
<category>Мероприятия</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Мероприятие</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchCases(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Удаляет группу мероприятий с указанными в запросе ИД</summary>
<param name="casesids">Список ИД мероприятий</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<short>Удалить группу мероприятий</short>
<category>Мероприятия</category>
<returns>Список мероприятий</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchCases(System.Int32,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String})">
<summary>Удаляет список всех мероприятий, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="isClosed">Статус мероприятия</param>
<param optional="true" name="tags">Теги</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<short>Удалить группу мероприятий</short>
<category>Мероприятия</category>
<returns>Список мероприятий</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCasesMembers(System.Int32)">
<summary>Возвращает список всех контактов, связанных с мероприятием, ИД которого указан в запросе</summary>
<short>Получить список всех контактов мероприятия</short>
<param name="caseid">ИД мероприятия</param>
<category>Мероприятия</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddMemberToCases(System.Int32,System.Int32)">
<summary>Добавляет выбранный контакт в мероприятие, ИД которого указан в запросе</summary>
<short>Добавить контакт мероприятия</short>
<category>Мероприятия</category>
<param name="caseid">ИД мероприятия</param>
<param name="contactid">ИД контакта</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Участник</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteMemberFromCases(System.Int32,System.Int32)">
<summary>Удаляет выбранный контакт из мероприятия, ИД которого указан в запросе</summary>
<short>Удалить контакт из мероприятия</short>
<category>Мероприятия</category>
<param name="caseid">ИД мероприятия</param>
<param name="contactid">ИД контакта</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Участник</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCasesByPrefix(System.String,System.Int32)">
<summary>Возвращает список, состоящий из 30 мероприятий в модуле CRM с префиксом</summary>
2019-02-13 12:12:23 +00:00
<param optional="true" name="prefix"></param>
<param optional="true" name="contactID"></param>
<category>Мероприятия</category>
<returns>Список мероприятий</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactInfoCategory(ASC.CRM.Core.ContactInfoType)">
<summary>Возвращает список всех доступных категорий контактов</summary>
<param name="infoType">Тип информации о контакте</param>
<short>Получить все категории</short>
<category>Контакты</category>
<returns>Список всех доступных категорий контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactInfoType">
<summary>Возвращает список всех доступных типов информации о контакте</summary>
<short>Получить все типы информации о контакте</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactInfo(System.Int32)">
<summary>Возвращает подробные сведения о контакте</summary>
<param name="contactid">ИД контакта</param>
<short>Получить информацию о контакте</short>
<category>Контакты</category>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactInfoByID(System.Int32,System.Int32)">
<summary>Возвращает подробный список всей доступной информации о конаткте с указанным в запросе ИД</summary>
<param name="contactid">ИД контакта</param>
<param name="id">ИД информации о контакте</param>
<short>Получить информацию о контакте</short>
<category>Контакты</category>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateContactInfo(System.Int32,ASC.CRM.Core.ContactInfoType,System.String,System.Boolean,System.String)">
<summary>Добавляет информацию с указанными в запросе параметрами к контакту с выбранным ИД</summary>
<param name="contactid">ИД контакта</param>
<param name="infoType">Тип информации о контакте</param>
<param name="data">Данные</param>
<param name="isPrimary">Важность контакта: основной или нет</param>
<param name="category">Группа</param>
<short>Добавить информацию о контакте</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<seealso cref="M:ASC.Api.CRM.CRMApi.GetContactInfoType"/>
<seealso cref="M:ASC.Api.CRM.CRMApi.GetContactInfoCategory(ASC.CRM.Core.ContactInfoType)"/>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateBatchContactInfo(System.Int32,System.Collections.Generic.IEnumerable{ASC.Api.CRM.Wrappers.ContactInfoWrapper})">
<summary>Создает информацию о контакте (добавляет новую информацию в старый список) с указанными в запросе параметрами для контакта с выбранным ИД</summary>
<short>Информация о контакте группы</short>
<param name="contactid">ИД контакта</param>
<param name="items">Информация о контакте</param>
2019-02-13 12:12:23 +00:00
<remarks>
<![CDATA[
items has format
[{infoType : 1, category : 1, categoryName : 'work', data : "myemail@email.com", isPrimary : true}, {infoType : 0, category : 0, categoryName : 'home', data : "+8999111999111", isPrimary : true}]
]]>
</remarks>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateContactInfo(System.Int32,System.Int32,System.Nullable{ASC.CRM.Core.ContactInfoType},System.String,System.Nullable{System.Boolean},System.String)">
<summary>Обновляет информацию о контакте с выбранным ИД, изменяя указанные в запросе параметры</summary>
<param name="id">ИД записи с информацией о контакте</param>
<param name="contactid">ИД контакта</param>
<param optional="true" name="infoType">Тип информации о контакте</param>
<param name="data">Данные</param>
<param optional="true" name="isPrimary">Важность контакта: основной или нет</param>
<param optional="true" name="category">Категория информации о контакте</param>
<short>Обновить информацию о контакте</short>
<category>Контакты</category>
<exception cref="T:System.ArgumentException"></exception>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateBatchContactInfo(System.Int32,System.Collections.Generic.IEnumerable{ASC.Api.CRM.Wrappers.ContactInfoWrapper})">
<summary>Обновляет информацию о контакте (старая информация удаляется и добавляется новый список) с указанными в запросе параметрами для контакта с выбранным ИД</summary>
<short>Обновление информации о контакте группы</short>
<param name="contactid">ИД контакта</param>
<param name="items">Информация о контакте</param>
2019-02-13 12:12:23 +00:00
<![CDATA[
items has format
[{infoType : 1, category : 1, categoryName : 'work', data : "myemail@email.com", isPrimary : true}, {infoType : 0, category : 0, categoryName : 'home', data : "+8999111999111", isPrimary : true}]
]]>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactInfo(System.Int32,ASC.CRM.Core.ContactInfoType)">
<summary>Возвращает подробные сведения о контакте с выбранным ИД исходя из указанного в запросе типа информации</summary>
<param name="contactid">ИД контакта</param>
<param name="infoType">Тип информации о контакте</param>
<short>Получить информацию о контакте по типу</short>
<category>Контакты</category>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteContactInfo(System.Int32,System.Int32)">
<summary>Удаляет информацию о контакте с указанным в запросе ИД</summary>
<param name="contactid">ИД контакта</param>
<param name="id">ИД записи с информацией о контакте</param>
<short>Удалить информацию о контакте</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Информация о контакте</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactByID(System.Int32)">
<summary>Возвращает подробные сведения о контакте с указанным в запросе ИД</summary>
<param name="contactid">ИД контакта</param>
<returns>Контакт</returns>
<short>Получить контакт по ИД</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactsByProjectID(System.Int32)">
<summary>Возвращает список контактов для проекта с указанным в запросе ИД</summary>
<short>Получить контакты по ИД проекта</short>
<param name="projectid">ИД проекта</param>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetRelativeContactToProject(System.Int32,System.Int32)">
<summary>Связывает выбранный контакт с проектом, ИД которого указан в запросе</summary>
<param name="contactid">ИД контакта</param>
<param name="projectid">ИД проекта</param>
<category>Контакты</category>
<short>Связать контакт с проектом</short>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Сведения о контакте</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetRelativeContactListToProject(System.Collections.Generic.IEnumerable{System.Int32},System.Int32)">
<summary>Связывает выбранный контакт с проектом, ИД которого указан в запросе</summary>
<param name="contactid">Массив ИД контактов</param>
<param name="projectid">ИД проекта</param>
<category>Контакты</category>
<short>Связать список контактов с проектом</short>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.RemoveRelativeContactToProject(System.Int32,System.Int32)">
<summary>Удаляет ссылку на выбранный проект из контакта, ИД которого указан в запросе</summary>
<param name="contactid">ИД контакта</param>
<param name="projectid">ИД проекта</param>
<category>Контакты</category>
<short>Удалить контакт из проекта</short>
<returns>Сведения о контакте</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddDealToContact(System.Int32,System.Int32)">
<summary>Добавляет выбранную возможную сделку к контакту, ИД которого указан в запросе. То же, что и в случае параметра AddMemberToDeal</summary>
<param name="opportunityid">ИД возможной сделки</param>
<param name="contactid">ИД контакта</param>
<short>Добавить возможную сделку к контакту</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Возможная сделка</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteDealFromContact(System.Int32,System.Int32)">
<summary>Удаляет выбранную возможную сделку из контакта, ИД которого указан в запросе</summary>
<param name="opportunityid">ИД возможной сделки</param>
<param name="contactid">ИД контакта</param>
<short>Добавить возможную сделку к контакту</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Возможная сделка</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContacts(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},ASC.CRM.Core.ContactListViewType,System.Nullable{System.Guid},System.Nullable{System.Boolean},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
<summary>Добавляет список всех контактов в модуле CRM, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="tags">Тег</param>
<param optional="true" name="contactStage">ИД стадии контакта (теплоты отношений)</param>
<param optional="true" name="contactType">ИД типа контакта</param>
2019-02-13 12:12:23 +00:00
<param optional="true" name="contactListView" remark="Allowed values: Company, Person, WithOpportunity"></param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<param optional="true" name="responsibleid">ИД ответственного</param>
<param optional="true" name="isShared">ИД ответственного</param>
<short>Получить список контактов</short>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SearchContactsByEmail(System.String,System.Int32)">
<summary>Возвращает список контактов для функции автозаполнения.</summary>
<param name="term">Часть строки с именем контакта, фамилией или адресом электронной почты.</param>
<param name="maxCount">Максимальное число результатов</param>
<short>Поиск в списке контактов</short>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetSimpleContacts(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},ASC.CRM.Core.ContactListViewType,System.Nullable{System.Guid},System.Nullable{System.Boolean},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
<summary>Добавляет список всех контактов в модуле CRM, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="tags">Тег</param>
<param optional="true" name="contactStage">ИД стадии контакта (теплоты)</param>
<param optional="true" name="contactType">ИД типа контакта</param>
2019-02-13 12:12:23 +00:00
<param optional="true" name="contactListView" remark="Allowed values: Company, Person, WithOpportunity"></param>
<param optional="true" name="responsibleid">ИД ответственного</param>
<param optional="true" name="isShared">ИД ответственного</param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<short>Получить список контактов</short>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactsForMail(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Получить группу контактов с указанными в запросе ИД</summary>
<param name="contactids">Список ИД контактов</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<short>Получить группу контактов</short>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchContacts(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},ASC.CRM.Core.ContactListViewType,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
<summary>Удаляет список всех контактов в модуле CRM, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="tags">Тег</param>
<param optional="true" name="contactStage">ИД стадии контакта (теплоты отношений)</param>
<param optional="true" name="contactType">ИД типа контакта</param>
2019-02-13 12:12:23 +00:00
<param optional="true" name="contactListView" remark="Allowed values: Company, Person, WithOpportunity"></param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<short>Удалить список всех контактов</short>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetPeopleFromCompany(System.Int32)">
<summary>Возвращает список всех связанных с компанией персон с указанным в запросе ИД</summary>
<param name="companyid">ИД компании</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<short>Получить список связанных с компанией персон</short>
<category>Контакты</category>
<returns>Связанные персоны</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddPeopleToCompany(System.Int32,System.Int32)">
<summary>Добавляет выбранную персону в компанию с указанным в запросе ИД</summary>
<param optional="true" name="companyid">ИД компании</param>
<param optional="true" name="personid">ИД персоны</param>
<short>Добавить персону в компанию</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Персона</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeletePeopleFromCompany(System.Int32,System.Int32)">
<summary>Удаляет выбранную персону из компании с указанным в запросе ИД</summary>
<param optional="true" name="companyid">ИД компании</param>
<param optional="true" name="personid">ИД персоны</param>
<short>Удалить персону из компании</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Персона</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreatePerson(System.String,System.String,System.String,System.Int32,System.String,ASC.Web.CRM.Core.Enums.ShareType,System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}},System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
<summary>Создает персону с указанными в запросе параметрами (имя, фамилия, описание и т. д.)</summary>
<param name="firstName">Имя</param>
<param name="lastName">Фамилия</param>
<param optional="true" name="jobTitle">Запись</param>
<param optional="true" name="companyId">ИД компании</param>
<param optional="true" name="about">Текст описания персоны</param>
<param name="shareType">Конфиденциальность персоны: 0 — без общего доступа, 1 — доступ для чтения и записи, 2 — доступ только для чтения</param>
<param optional="true" name="managerList">Список менеджеров персоны</param>
<param optional="true" name="customFieldList">Список пользовательских полей</param>
<param optional="true" name="photo">Фотография контакта (загрузите ее с помощью multipart/form-data)</param>
<short>Создать персону</short>
<category>Контакты</category>
<returns>Персона</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.ChangeContactPhoto(System.Int32,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
<summary>Изменяет фотографию контакта с указанным в запросе ИД</summary>
<param name="contactid">ИД контакта</param>
<param name="photo">Фотография контакта (загрузите ее с помощью multipart/form-data)</param>
<short>Изменить фотографию контакта</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Путь к фотографии контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.ChangeContactPhoto(System.Int32,System.String)">
<summary>Изменяет фотографию контакта с указанным в запросе ИД</summary>
<param name="contactid">ИД контакта</param>
<param name="photourl">Адрес фотографии контакта</param>
<short>Изменить фотографию контакта</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Путь к фотографии контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.MergeContacts(System.Int32,System.Int32)">
<summary>Объединить два выбранных контакта</summary>
<param name="fromcontactid">ИД первого объединяемого контакта</param>
<param name="tocontactid">ИД второго объединяемого контакта</param>
<short>Объединить контакты</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Контакт</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdatePerson(System.Int32,System.String,System.String,System.String,System.Int32,System.String,ASC.Web.CRM.Core.Enums.ShareType,System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}},System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
<summary>Обновляет выбранную персону, изменяя указанные в запросе параметры (имя, фамилия, описание и т. д.)</summary>
<param name="personid">ИД персоны</param>
<param name="firstName">Имя</param>
<param name="lastName">Фамилия</param>
<param optional="true" name="jobTitle">Запись</param>
<param optional="true" name="companyId">ИД компании</param>
<param optional="true" name="about">Текст описания персоны</param>
<param name="shareType">Конфиденциальность персоны: 0 — без общего доступа, 1 — доступ для чтения и записи, 2 — доступ только для чтения</param>
<param optional="true" name="managerList">Список менеджеров персоны</param>
<param optional="true" name="customFieldList">Список пользовательских полей</param>
<param optional="true" name="photo">Фотография контакта (загрузите ее с помощью multipart/form-data)</param>
<short>Обновить персону</short>
<category>Контакты</category>
<returns>Персона</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateCompany(System.String,System.String,System.Collections.Generic.IEnumerable{System.Int32},ASC.Web.CRM.Core.Enums.ShareType,System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}},System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
<summary>Создает компанию с указанными в запросе параметрами</summary>
<param name="companyName">Название компании</param>
<param optional="true" name="about">Текст описания компании</param>
<param optional="true" name="personList">Список связанных персон</param>
<param name="shareType">Конфиденциальность компании: 0 — без общего доступа, 1 — доступ для чтения и записи, 2 — доступ только для чтения</param>
<param optional="true" name="managerList">Список менеджеров для компании</param>
<param optional="true" name="customFieldList">Список пользовательских полей</param>
<param optional="true" name="photo">Фотография контакта (загрузите ее с помощью multipart/form-data)</param>
<short>Создать компанию</short>
<category>Контакты</category>
<returns>Компания</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateCompany(System.Collections.Generic.IEnumerable{System.String})">
<summary>Быстро создает список компаний</summary>
<short>Быстрое создание списка компаний</short>
<param name="companyName">Название компании</param>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreatePerson(System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}})">
<summary>Быстро создает список персон, имена и фамилии которых указаны в запросе</summary>
<short>Быстрое создание списка персон</short>
<param name="data">Пары: имя пользователя, фамилия пользователя</param>
2019-02-13 12:12:23 +00:00
<remarks>
<![CDATA[
data has format
[{key: 'Имя 1', value: 'Фамилия 1'},{key: ‘Имя 2', value: 'Фамилия 2'}]
2019-02-13 12:12:23 +00:00
]]>
</remarks>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCompany(System.Int32,System.String,System.String,ASC.Web.CRM.Core.Enums.ShareType,System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}})">
<summary>Обновляет выбранную компанию, изменяя указанные в запросе параметры</summary>
<param name="companyid">ИД компании</param>
<param name="companyName">Название компании</param>
<param optional="true" name="about">Текст описания компании</param>
<param name="shareType">Конфиденциальность компании: 0 — без общего доступа, 1 — доступ для чтения и записи, 2 — доступ только для чтения</param>
<param optional="true" name="managerList">Список менеджеров компании</param>
<param optional="true" name="customFieldList">Список пользовательских полей</param>
<short>Обновить компанию</short>
<category>Контакты</category>
<exception cref="T:System.ArgumentException"></exception>
<returns>Компания</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateContactStatus(System.Int32,System.Int32)">
<summary>Обновляет статус выбранного контакта</summary>
<param name="contactid">ИД контакта</param>
<param name="contactStatusid">ИД статуса контакта</param>
<short>Обновить статус в контакте по ИД</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Компания</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCompanyAndParticipantsStatus(System.Int32,System.Int32)">
<summary>Обновляет статус выбранной компании и всех ее участников</summary>
<param name="companyid">ИД компании</param>
<param name="contactStatusid">ИД статуса контакта</param>
<short>Обновить статус компании и участников</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Компания</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdatePersonAndItsCompanyStatus(System.Int32,System.Int32)">
<summary>Обновляет статус выбранной персоны, связанной с ним компании и всех ее участников</summary>
<param name="personid">ИД персоны</param>
<param name="contactStatusid">ИД статуса контакта</param>
<short>Обновить статус персоны, связанной с ним компании и всех участников</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Персона</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToContact(System.Int32,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа других пользователей к контакту с указанным в запросе ИД</summary>
<param name="contactid">ИД контакта</param>
<param name="isShared">Конфиденциальность контакта: конфиденциальный или нет</param>
<param name="managerList">Список менеджеров</param>
<short>Назначить права доступа к контакту</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Контакт</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToBatchContact(System.Collections.Generic.IEnumerable{System.Int32},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа других пользователей к списку контактов с указанными в запросе ИД</summary>
<param name="contactid">Список ИД контактов</param>
<param name="isShared">Конфиденциальность компании: предоставляется ли общий доступ или нет</param>
<param name="managerList">Список менеджеров</param>
<short>Назначить права доступа к контакту</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToBatchContact(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},ASC.CRM.Core.ContactListViewType,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа выбранного пользователя к списку контактов с указанными в запросе параметрами</summary>
<param name="isPrivate">Конфиденциальность контакта: конфиденциальный или нет</param>
<param name="managerList">Список менеджеров</param>
<param optional="true" name="tags">Тег</param>
<param optional="true" name="contactStage">ИД стадии контакта (теплоты отношений)</param>
<param optional="true" name="contactType">ИД типа контакта</param>
2019-02-13 12:12:23 +00:00
<param optional="true" name="contactListView" remark="Allowed values: Company, Person, WithOpportunity"></param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<short>Назначить права доступа к контакту</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteContact(System.Int32)">
<summary>Удаляет с портала контакт, ИД которого указан в запросе</summary>
<short>Удалить контакт</short>
<category>Контакты</category>
<param name="contactid">ИД контакта</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Контакт</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchContacts(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Удаляет группу контактов, ИД которых указан в запросе</summary>
<param name="contactids">Список ИД контактов</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<short>Удалить группу контактов</short>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactsByPrefix(System.String,System.Int32,ASC.CRM.Core.EntityType,System.Int32)">
<summary>Возвращает список, состоящий из 30 контактов в модуле CRM с префиксом</summary>
2019-02-13 12:12:23 +00:00
<param optional="true" name="prefix"></param>
<param optional="false" name="searchType" remark="Allowed values: -1 (Any), 0 (Company), 1 (Persons), 2 (PersonsWithoutCompany), 3 (CompaniesAndPersonsWithoutCompany)">searchType</param>
<param optional="true" name="entityType"></param>
<param optional="true" name="entityID"></param>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactsByContactInfo(System.Nullable{ASC.CRM.Core.ContactInfoType},System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean})">
<summary>Возвращает список контактов в модуле CRM с информацией о контакте</summary>
<param optional="false" name="infoType">Тип информации о контакте</param>
<param optional="false" name="data">Данные</param>
<param optional="true" name="category">Группа</param>
<param optional="true" name="isPrimary">Важность контакта: основной или нет</param>
<category>Контакты</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetUserTweets(System.Int32,System.Int32)">
<summary>
</summary>
<param name="contactid"></param>
<param name="count"></param>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.FindTwitterProfiles(System.String)">
<summary>
</summary>
<param name="searchText"></param>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteContactAvatar(System.Int32,System.String,System.Boolean)">
<summary>
</summary>
<param name="contactId"></param>
<param name="contactType"></param>
<param name="uploadOnly"></param>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactSMImages(System.Int32)">
<summary>
</summary>
<param name="contactId"></param>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactSMImagesByNetworks(System.Collections.Generic.List{ASC.Api.CRM.Wrappers.ContactInfoWrapper})">
<summary>
</summary>
<param name="socialNetworks"></param>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UploadUserAvatarFromSocialNetwork(System.Int32,ASC.Thrdparty.SocialNetworks,System.String,System.Boolean,System.String)">
<summary>
</summary>
<param name="contactId"></param>
<param name="socialNetwork"></param>
<param name="userIdentity"></param>
<param name="uploadOnly"></param>
<param name="tmpDirName" visible="false"></param>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SendMailSMTPToContacts(System.Collections.Generic.List{System.Int32},System.Collections.Generic.List{System.Int32},System.String,System.String,System.Boolean)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetMailSMTPToContactsPreview(System.String,System.Int32)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetMailSMTPToContactsStatus">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CancelMailSMTPToContacts">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetContactCreationDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetContactLastModifedDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.#ctor(ASC.Api.Impl.ApiContext)">
<summary>Конструктор</summary>
2019-02-13 12:12:23 +00:00
<param name="context"></param>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCustomFieldDefinitions(System.String)">
<summary>Возвращает список описаний для всех существующих пользовательских полей</summary>
<param name="entityType" remark="Allowed values: contact,person,company,opportunity,case">Тип</param>
<short>Получить список пользовательских полей</short>
<category>Пользовательские поля</category>
<returns>Список пользовательских полей</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCustomFieldForSubject(System.String,System.Int32)">
<summary>Возвращает список всех значений пользовательских полей исходя из указанных в запросе типа сущности и ИД сущности</summary>
<param name="entityType" remark="Allowed values: contact,person,company,opportunity,case">Тип</param>
<param name="entityid">ИД</param>
<short>Получить значения пользовательских полей</short>
<category>Пользовательские поля</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetEntityCustomFieldValue(System.String,System.Int32,System.Int32,System.String)">
<summary>Задает новое значение пользовательского поля с помощью указанных в запросе типа сущности, ИД, ИД поля и значения</summary>
<param name="entityType" remark="Allowed values: contact,person,company,opportunity,case">Тип</param>
<param name="entityid">ИД</param>
<param name="fieldid">ИД поля</param>
<param name="fieldValue">Значение поля</param>
<short>Задать значение пользовательского поля</short>
<category>Пользовательские поля</category>
<returns>Пользовательское поле</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateCustomFieldValue(System.String,System.String,System.Int32,System.Int32,System.String)">
<summary>Создает новое пользовательское поле с указанными в запросе параметрами (тип сущности, название поля, тип и т. д.)</summary>
<param optional="false" name="entityType" remark="Allowed values: contact,person,company,opportunity,case">Тип сущности</param>
<param optional="false" name="label">Название поля</param>
2019-02-13 12:12:23 +00:00
<param name="fieldType"
remark="Allowed values: TextField, TextArea, SelectBox, CheckBox, Heading or Date">Значение пользовательского поля</param>
<param optional="true" name="position">Позиция поля</param>
<param optional="true" name="mask" remark="Sent in json format only" >Маска</param>
<short>Создать пользовательское поле</short>
<category>Пользовательские поля</category>
<returns>Пользовательское поле</returns>
2019-02-13 12:12:23 +00:00
<example>
<![CDATA[
Передача данных в формате application/json:
2019-02-13 12:12:23 +00:00
1) Creation of a user field of TextField type
data: {
entityType: "contact",
label: "ПримерTextField",
2019-02-13 12:12:23 +00:00
fieldType: 0,
position: 0,
mask: {"size":"40"} - размер текстового поля. Все остальные значения игнорируются.
2019-02-13 12:12:23 +00:00
}
2) Создание пользовательского поля типа TextArea
2019-02-13 12:12:23 +00:00
data: {
entityType: "contact",
label: "Пример TextArea",
2019-02-13 12:12:23 +00:00
fieldType: 1,
position: 1,
mask: '{"rows":"2","cols":"30"}' - размер TextArea. Все остальные значения игнорируются.
2019-02-13 12:12:23 +00:00
}
3) Создание пользовательского поля типа SelectBox
2019-02-13 12:12:23 +00:00
data: {
entityType: "contact",
label: "Пример SelectBox",
2019-02-13 12:12:23 +00:00
fieldType: 2,
position: 0,
mask: ["1","2","3"] - Значения SelectBox.
2019-02-13 12:12:23 +00:00
}
4) Создание пользовательского поля типа CheckBox
2019-02-13 12:12:23 +00:00
data: {
entityType: "contact",
label: "Пример CheckBox",
2019-02-13 12:12:23 +00:00
fieldType: 3,
position: 0,
mask: ""
}
5) Создание пользовательского поля типа Heading
2019-02-13 12:12:23 +00:00
data: {
entityType: "contact",
label: "Пример Heading",
2019-02-13 12:12:23 +00:00
fieldType: 4,
position: 0,
mask: ""
}
6) Создание пользовательского поля типа Date
2019-02-13 12:12:23 +00:00
data: {
entityType: "contact",
label: "Пример Date",
2019-02-13 12:12:23 +00:00
fieldType: 5,
position: 0,
mask: ""
}
]]>
</example>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCustomFieldValue(System.Int32,System.String,System.String,System.Int32,System.Int32,System.String)">
<summary>Обновляет выбранное пользовательское поле, изменяя указанные в запросе параметры (тип сущности, название поля, тип и т. д.)</summary>
<param name="id">ИД пользовательского поля</param>
<param name="entityType" remark="Allowed values: contact,person,company,opportunity,case">Тип сущности</param>
<param optional="false" name="label">Название поля</param>
<param name="fieldType" remark="Allowed values: 0 (TextField),1 (TextArea),2 (SelectBox),3 (CheckBox),4 (Heading) or 5 (Date)">Значение пользовательского поля</param>
<param optional="true" name="position">Позиция поля</param>
<param optional="true" name="mask" remark="Sent in json format only">Маска</param>
<short>Обновляет выбранное пользовательское поле</short>
<category>Пользовательские поля</category>
<returns>Пользовательское поле</returns>
2019-02-13 12:12:23 +00:00
<remarks>
<![CDATA[
Вы можете обновить поле, если нет связанных элементов. При наличии подобных элементов обновлены будут лишь метка и маска. Другие параметры будут проигнорированы.
2019-02-13 12:12:23 +00:00
]]>
</remarks>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteCustomField(System.String,System.Int32)">
<summary>Удаляет пользовательское поле с указанным в запросе ИД</summary>
<param name="entityType" remark="Allowed values: contact,person,company,opportunity,case">Тип</param>
<param name="fieldid">ИД поля</param>
<short>Удалить пользовательское поле</short>
<category>Пользовательские поля</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Пользовательское поле</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCustomFieldsOrder(System.Collections.Generic.IEnumerable{System.Int32},System.String)">
<summary>Обновляет порядок пользовательских полей</summary>
<param name="fieldids">Список ИД пользовательских полей</param>
<param name="entityType" remark="Allowed values: contact,person,company,opportunity,case">Тип сущности</param>
<category>Пользовательские поля</category>
<returns>Пользовательские поля</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetDealByID(System.Int32)">
<summary>Возвращает подробные сведения о возможной сделке, ИД которой указан в запросе</summary>
<param name="opportunityid">ИД возможной сделки</param>
<returns>Возможная сделка</returns>
<short>Получить возможную сделку по ИД</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateToDealMilestone(System.Int32,System.Int32)">
<summary>Обновляет выбранную возможную сделку до стадии, ИД которой указан в запросе</summary>
<param name="opportunityid">ИД возможной сделки</param>
<param name="stageid">ИД стадии возможной сделки</param>
<returns>Возможная сделка</returns>
<short>Обновить стадию возможной сделки</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToDeal(System.Int32,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа к выбранной возможной сделке с указанными в запросе параметрами</summary>
<param name="opportunityid">ИД возможной сделки</param>
<param name="isPrivate">Конфиденциальность возможной сделки: конфиденциальная или нет</param>
<param name="accessList">Список имеющих доступ пользователей</param>
<short>Назначить права по отношению к возможной сделке</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Возможная сделка</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToBatchDeal(System.Guid,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.Int32,System.Nullable{ASC.CRM.Core.DealMilestoneStatus},System.Nullable{System.Boolean},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа других пользователей к списку всех возможных сделок, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="responsibleid">Ответственный за возможную сделку</param>
<param optional="true" name="opportunityStagesid">ИД стадии возможной сделки</param>
<param optional="true" name="tags">Теги</param>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="contactAlsoIsParticipant">Статус участия: учитывать возможные сделки, где контакт является участником, или нет</param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<param optional="true" name="stageType" remark="Allowed values: {Open, ClosedAndWon, ClosedAndLost}">Тип стадии возможной сделки</param>
<param name="isPrivate">Конфиденциальность возможной сделки: конфиденциальная или нет</param>
<param name="accessList">Список имеющих доступ пользователей</param>
<short>Назначить права доступа к возможной сделке</short>
<category>Возможные сделки</category>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Список возможных сделок</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetAccessToBatchDeal(System.Collections.Generic.IEnumerable{System.Int32},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Определяет права доступа других пользователей к списку возможных сделок с указанными в запросе ИД</summary>
<param name="opportunityid">Список ИД возможных сделок</param>
<param name="isPrivate">Конфиденциальность возможной сделки: конфиденциальная или нет</param>
<param name="accessList">Список имеющих доступ пользователей</param>
<short>Назначить права доступа к возможной сделке</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Список возможных сделок</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchDeals(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Удаляет группу возможных сделок с указанными в запросе ИД</summary>
<param name="opportunityids">Список ИД возможных сделок</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<short>Удалить группу возможных сделок</short>
<category>Возможные сделки</category>
<returns>Список возможных сделок</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteBatchDeals(System.Guid,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.Int32,System.Nullable{ASC.CRM.Core.DealMilestoneStatus},System.Nullable{System.Boolean},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
<summary>Удаляет список всех возможных сделок, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="responsibleid">Ответственный за возможную сделку</param>
<param optional="true" name="opportunityStagesid">ИД стадии возможной сделки</param>
<param optional="true" name="tags">Теги</param>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="contactAlsoIsParticipant">Статус участия: учитывать возможные сделки, где контакт является участником, или нет</param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<param optional="true" name="stageType" remark="Allowed values: {Open, ClosedAndWon, ClosedAndLost}">Тип стадии возможной сделки</param>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<short>Удалить группу возможных сделок</short>
<category>Возможные сделки</category>
<returns>Список возможных сделок</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetDeals(System.Guid,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.Int32,System.Nullable{ASC.CRM.Core.DealMilestoneStatus},System.Nullable{System.Boolean},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
<summary>Возвращает список всех возможных сделок, соответствующих указанным в запросе параметрам</summary>
<param optional="true" name="responsibleid">Ответственный за возможную сделку</param>
<param optional="true" name="opportunityStagesid">ИД стадии возможной сделки</param>
<param optional="true" name="tags">Теги</param>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="contactAlsoIsParticipant">Статус участия: учитывать возможные сделки, где контакт является участником, или нет</param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<param optional="true" name="stageType" remark="Allowed values: {Open, ClosedAndWon, ClosedAndLost}">Тип стадии возможной сделки</param>
<short>Получить список возможных сделок</short>
<category>Возможные сделки</category>
<returns>Список возможных сделок</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteDeal(System.Int32)">
<summary>Удаляет возможную сделку с указанным в запросе ИД</summary>
<param name="opportunityid">ИД возможной сделки</param>
<short>Удалить возможную сделку</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Возможная сделка</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateDeal(System.Int32,System.Collections.Generic.IEnumerable{System.Int32},System.String,System.String,System.Guid,ASC.CRM.Core.BidType,System.Decimal,System.String,System.Int32,System.Int32,System.Int32,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid},System.Boolean)">
<summary>Создает возможную сделку с указанными в запросе параметрами</summary>
<short>Создать возможную сделку</short>
<param name="contactid">Основной контакт возможной сделки</param>
<param optional="true" name="members">Участники</param>
<param name="title">Название возможной сделки</param>
<param optional="true" name="description">Описание возможной сделки</param>
<param name="responsibleid">Ответственный за возможную сделку</param>
<param name="bidType" remark="Allowed values: FixedBid, PerHour, PerDay,PerWeek, PerMonth, PerYear">Предложение цены</param>
<param optional="true" name="bidValue">Сумма сделки</param>
<param name="bidCurrencyAbbr">Валюта (аббревиатура)</param>
<param name="perPeriodValue">Период</param>
<param name="stageid">ИД стадии</param>
<param optional="true" name="successProbability">Вероятность успеха возможной сделки</param>
<param optional="true" name="actualCloseDate">Фактическая дата закрытия возможной сделки</param>
<param optional="true" name="expectedCloseDate">Прогнозируемая дата закрытия возможной сделки</param>
<param optional="true" name="customFieldList">Список пользовательских полей</param>
<param name="isPrivate">Конфиденциальность возможной сделки: конфиденциальная или нет</param>
<param optional="true" name="accessList">Список пользователей, имеющих доступ к возможной сделке</param>
<param name="isNotify" optional="true">Уведомить пользователей в списке доступа о возможной сделке</param>
<category>Возможные сделки</category>
<returns>Возможная сделка</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateDeal(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.Int32},System.String,System.String,System.Guid,ASC.CRM.Core.BidType,System.Decimal,System.String,System.Int32,System.Int32,System.Int32,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}},System.Boolean,System.Collections.Generic.IEnumerable{System.Guid},System.Boolean)">
<summary>Обновляет выбранную возможную сделку, изменяя указанные в запросе параметры</summary>
<short>Обновить возможную сделку</short>
<param name="opportunityid">ИД возможной сделки</param>
<param name="contactid">Основной контакт возможной сделки</param>
<param optional="true" name="members">Участники</param>
<param name="title">Название возможной сделки</param>
<param optional="true" name="description">Описание возможной сделки</param>
<param name="responsibleid">Ответственный за возможную сделку</param>
<param name="bidType" remark="Allowed values: FixedBid, PerHour, PerDay,PerWeek, PerMonth, PerYear">Предложение цены</param>
<param optional="true" name="bidValue">Сумма сделки</param>
<param optional="true" name="bidCurrencyAbbr">Валюта (аббревиатура)</param>
<param name="perPeriodValue">Период</param>
<param name="stageid">ИД стадии</param>
<param optional="true" name="successProbability">Вероятность успеха возможной сделки</param>
<param optional="true" name="actualCloseDate">Фактическая дата закрытия возможной сделки</param>
<param optional="true" name="expectedCloseDate">Прогнозируемая дата закрытия возможной сделки</param>
<param optional="true" name="customFieldList">Список пользовательских полей</param>
<param name="isPrivate">Конфиденциальность возможной сделки: конфиденциальная или нет</param>
<param optional="true" name="accessList">Список пользователей, имеющих доступ к возможной сделке</param>
<param name="isNotify" optional="true">Уведомить пользователей в списке доступа о возможной сделки</param>
<category>Возможные сделки</category>
<returns>Возможная сделка</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetDealMembers(System.Int32)">
<summary>Возвращает список всех контактов, связанных с возможной сделкой, ИД которой указан в запросе</summary>
<param name="opportunityid">ИД возможной сделки</param>
<short>Получить все контакты возможной сделки</short>
<category>Возможные сделки</category>
<returns>Список контактов</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddMemberToDeal(System.Int32,System.Int32)">
<summary>Добавляет выбранный контакт к возможной сделке, ИД которой указан в запросе</summary>
<param name="opportunityid">ИД возможной сделки</param>
<param name="contactid">ИД контакта</param>
<short>Добавить контакт к возможной сделке</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Участник</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteMemberFromDeal(System.Int32,System.Int32)">
<summary>Удаляет выбранный контакт из возможной сделки, ИД которой указан в запросе</summary>
<param name="opportunityid">ИД возможной сделки</param>
<param name="contactid">ИД контакта</param>
<short>Удалить контакт из возможной сделки</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Участник</returns>
2019-02-13 12:12:23 +00:00
</member>
2019-02-14 12:43:24 +00:00
<member name="M:ASC.Api.CRM.CRMApi.GetDealsByPrefix(System.String,System.Int32,System.Boolean)">
<summary>Возвращает список, состоящий из 30 возможных сделок в модуле CRM с префиксом</summary>
2019-02-13 12:12:23 +00:00
<param optional="true" name="prefix"></param>
<param optional="true" name="contactID"></param>
2019-02-14 12:43:24 +00:00
<param optional="true" name="internalSearch"></param>
<category>Возможные сделки</category>
<returns>Список возможных сделок</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetDeals(System.Int32)">
<summary>Возвращает список всех возможных сделок контакта</summary>
<param optional="true" name="contactid">ИД контакта</param>
<short>Получить список возможных сделок</short>
<category>Возможные сделки</category>
<returns>Список возможных сделок</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetDealCreationDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetDealLastModifedDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateDealMilestone(System.String,System.String,System.String,System.Int32,ASC.CRM.Core.DealMilestoneStatus)">
<summary>Создает стадию возможной сделки с указанными в запросе параметрами (названием, описанием, вероятностью успеха и т. д.)</summary>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="color">Цвет</param>
<param name="successProbability">Вероятность успеха</param>
<param name="stageType" remark="Allowed values: 0 (Open), 1 (ClosedAndWon),2 (ClosedAndLost)">Тип стадии</param>
<short>Создать стадию возможной сделки</short>
<category>Возможные сделки</category>
<exception cref="T:System.ArgumentException"></exception>
<returns>Стадия возможной сделки</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateDealMilestone(System.Int32,System.String,System.String,System.String,System.Int32,ASC.CRM.Core.DealMilestoneStatus)">
<summary>Обновляет выбранную стадию возможной сделки, изменяя указанные в запросе параметры (название, описание, вероятность успеха и т. д.)</summary>
<param name="id">ИД стадии возможной сделки</param>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="color">Цвет</param>
<param name="successProbability">Вероятность успеха</param>
<param name="stageType" remark="Allowed values: Open, ClosedAndWon, ClosedAndLost">Тип стадии</param>
<short>Обновить стадию возможной сделки</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Стадия возможной сделки</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateDealMilestoneColor(System.Int32,System.String)">
<summary>Обновляет выбранную стадию возможной сделки, изменяя указанный в запросе цвет</summary>
<param name="id">ИД стадии возможной сделки</param>
<param name="color">Цвет</param>
<short>Обновить цвет стадии возможной сделки</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Стадия возможной сделки</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateDealMilestonesOrder(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Обновляет имеющийся порядок стадий возможной сделки с помощью указанного в запросе списка</summary>
<short>Обновить порядок стадий возможной сделки</short>
<param name="ids">Список ИД стадий возможной сделки</param>
<category>Возможные сделки</category>
<returns>Стадии возможной сделки</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteDealMilestone(System.Int32)">
<summary>Удаляет стадию возможной сделки с указанным в запросе ИД</summary>
<short>Удалить стадию возможной сделки</short>
<category>Возможные сделки</category>
<param name="id">ИД стадии возможной сделки</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Стадия возможной сделки</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateHistoryCategory(System.String,System.String,System.String,System.Int32)">
<summary>Создает новую категорию истории с указанными в запросе параметрами (названием, описанием и т. д.)</summary>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="sortOrder">Порядок</param>
<param name="imageName">Название изображения</param>
<short>Создать категорию истории</short>
<category>История</category>
<returns>Категория истории</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateHistoryCategory(System.Int32,System.String,System.String,System.String,System.Int32)">
<summary>Обновляет выбранную категорию истории, изменяя указанные в запросе параметры (название, описание и т. д.)</summary>
<param name="id">ИД категории истории</param>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="sortOrder">Порядок</param>
<param name="imageName">Название изображения</param>
<short>Обновить категорию истории</short>
<category>История</category>
<returns>Категория истории</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateHistoryCategoryIcon(System.Int32,System.String)">
<summary>Обновляет значок выбранной истории категории</summary>
<param name="id">ИД категории истории</param>
<param name="imageName">название значка</param>
<short>Обновить значок категории истории</short>
<category>История</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Категория истории</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateHistoryCategoriesOrder(System.Collections.Generic.IEnumerable{System.String})">
<summary>Обновляет порядок категорий истории с помощью указанного в запросе списка</summary>
<short>Обновить порядок категорий истории</short>
<param name="titles">Список названий категорий истории</param>
<category>История</category>
<returns>Категории истории</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteHistoryCategory(System.Int32)">
<summary>Удаляет выбранную категорию истории с указанным в запросе ИД</summary>
<short>Удалить категорию истории</short>
<category>История</category>
<param name="id">ИД категории истории</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
<returns>Категория истории</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTaskCategory(System.String,System.String,System.String,System.Int32)">
<summary>Создает новую категорию задачи с указанными в запросе параметрами (названием, описанием и т. д.)</summary>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="sortOrder">Порядок</param>
<param name="imageName">Название изображения</param>
<short>Создать категорию задачи</short>
<category>Задачи</category>
<returns>Категория задачи</returns>
<exception cref="T:System.ArgumentException"></exception>
<returns>Категория задачи</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTaskCategory(System.Int32,System.String,System.String,System.String,System.Int32)">
<summary>Обновляет выбранную категорию задачи, изменяя указанные в запросе параметры (название, описание и т. д.)</summary>
<param name="id">ИД категории задачи</param>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="sortOrder">Порядок</param>
<param name="imageName">Название изображения</param>
<short>Обновить категорию задачи</short>
<category>Задачи</category>
<returns>Категория задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
<returns>Категория задачи</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTaskCategoryIcon(System.Int32,System.String)">
<summary>Обновляет значок категории задачи с указанным в запросе ИД</summary>
<param name="id">ИД категории задачи</param>
<param name="imageName">название значка</param>
<short>Обновить значок категории задачи</short>
<category>Задачи</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Категория задачи</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTaskCategoriesOrder(System.Collections.Generic.IEnumerable{System.String})">
<summary>Обновляет порядок категорий задачи с помощью указанного в запросе списка</summary>
<short>Обновить порядок категорий задачи</short>
<param name="titles">Список названий категорий задачи</param>
<category>Задачи</category>
<returns>Категории задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTaskCategory(System.Int32,System.Int32)">
<summary>Удаляет категорию задачи с указанным в запросе ИД</summary>
<short>Удалить категорию задачи</short>
<category>Задачи</category>
<param name="categoryid">ИД категории задачи</param>
<param name="newcategoryid">ИД категории задачи для замены в задаче с текущей стадией категории</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateContactStatus(System.String,System.String,System.String,System.Int32)">
<summary>Создает новый статус контакта с указанными в запросе параметрами (названием, описанием и т. д.)</summary>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="color">Цвет</param>
<param name="sortOrder">Порядок</param>
<returns>Статус контакта</returns>
<short>Создать статус контакта</short>
<category>Контакты</category>
<exception cref="T:System.ArgumentException"></exception>
<returns>Статус контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateContactStatus(System.Int32,System.String,System.String,System.String,System.Int32)">
<summary>Обновляет статус выбранного контакта, изменяя указанные в запросе параметры (название, описание и т. д.)</summary>
<param name="id">ИД статуса контакта</param>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="color">Цвет</param>
<param name="sortOrder">Порядок</param>
<returns>Статус контакта</returns>
<short>Обновить статус контакта</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
<returns>Статус контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateContactStatusColor(System.Int32,System.String)">
<summary>Обновляет цвет выбранного статуса контакта, заменяя его указанным в запросе новым цветом</summary>
<param name="id">ИД статуса контакта</param>
<param name="color">Цвет</param>
<short>Обновить цвет статуса контакта</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Статус контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateContactStatusesOrder(System.Collections.Generic.IEnumerable{System.String})">
<summary>Обновляет порядок статусов контакта с помощью указанного в запросе списка</summary>
<short>Обновить порядок статусов контакта</short>
<param name="titles">Список названий статусов контакта</param>
<category>Контакты</category>
<returns>Статусы контакта</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteContactStatus(System.Int32)">
<summary>Удаляет статус контакта с указанным в запросе ИД</summary>
<short>Удалить статус контакта</short>
<category>Контакты</category>
<param name="contactStatusid">ИД статуса контакта</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
<returns>Статус контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactStatusByID(System.Int32)">
<summary>Возвращает статус контакта для указанного в запросе ИД</summary>
<param name="contactStatusid">ИД статуса контакта</param>
<returns>Статус контакта</returns>
<short>Получить статус контакта</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateContactType(System.String,System.Int32)">
<summary>Создает новый тип контакта с указанными в запросе параметрами (названием и т. д.)</summary>
<param name="title">Заголовок</param>
<param name="sortOrder">Порядок</param>
<returns>Тип контакта</returns>
<short>Создать тип контакта</short>
<category>Контакты</category>
<exception cref="T:System.ArgumentException"></exception>
<returns>Тип контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateContactType(System.Int32,System.String,System.Int32)">
<summary>Обновляет выбранный тип контакта, изменяя указанные в запросе параметры (название, описание и т. д.)</summary>
<param name="id">ИД типа контакта</param>
<param name="title">Заголовок</param>
<param name="sortOrder">Порядок</param>
<returns>Тип контакта</returns>
<short>Обновить тип контакта</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
<returns>Тип контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateContactTypesOrder(System.Collections.Generic.IEnumerable{System.String})">
<summary>Обновляет порядок типов контакта с помощью указанного в запросе списка</summary>
<short>Обновить порядок типов контакта</short>
<param name="titles">Список названий типов контакта</param>
<category>Контакты</category>
<returns>Типы контакта</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteContactType(System.Int32)">
<summary>Удаляет тип контакта с указанным в запросе ИД</summary>
<short>Удалить тип контакта</short>
<category>Контакты</category>
<param name="contactTypeid">ИД типа контакта</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Security.SecurityException"></exception>
<returns>Тип контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactTypeByID(System.Int32)">
<summary>Возвращает тип контакта для указанного в запросе ИД</summary>
<param name="contactTypeid">ИД типа контакта</param>
<returns>Тип контакта</returns>
<short>Получить тип контакта</short>
<category>Контакты</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetDealMilestoneByID(System.Int32)">
<summary>Возвращает стадию возможной сделки с указанным в запросе ИД</summary>
<param name="stageid">ИД стадии возможной сделки</param>
<returns>Стадия возможной сделки</returns>
<short>Получить стадию возможной сделки</short>
<category>Возможные сделки</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskCategoryByID(System.Int32)">
<summary>Возвращает категорию задачи с указанным в запросе ИД</summary>
<param name="categoryid">ИД категории задачи</param>
<returns>Категория задачи</returns>
<short>Получить категорию задачи</short>
<category>Задачи</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetHistoryCategoryWrapper">
<summary>Возвращает список всех категорий истории, доступных на портале</summary>
<short>Получить все категории истории</short>
<category>История</category>
<returns>Список всех категорий истории</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskCategories">
<summary>Возвращает список всех категорий задачи, доступных на портале</summary>
<short>Получить все категории задачи</short>
<category>Задачи</category>
<returns>Список всех категорий задачи</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactStatuses">
<summary>Возвращает список всех статусов контакта, доступных на портале</summary>
<short>Получить все статусы контакта</short>
<category>Контакты</category>
<returns>Список всех статусов контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactTypes">
<summary>Возвращает список всех типов контакта, доступных на портале</summary>
<short>Получить все типы контакта</short>
<category>Контакты</category>
<returns>Список всех типов контакта</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetDealMilestones">
<summary>Возвращает список всех стадий возможной сделки, доступных на портале</summary>
<short>Получить все стадии возможной сделки</short>
<category>Возможные сделки</category>
<returns>Список всех стадий возможной сделки</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetHistory(System.String,System.Int32,System.Int32,System.Guid,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
<summary>Возвращает список всех событий, соответствующих указанным в запросе параметрам</summary>
<short>Получить список событий</short>
<category>История</category>
<param optional="true" name="entityType" remark="Allowed values: opportunity, contact or case">Тип связанной сущности</param>
<param optional="true" name="entityId">ИД связанной сущности</param>
<param optional="true" name="categoryId">ИД категории задачи</param>
<param optional="true" name="createBy">Организатор события</param>
<param optional="true" name="fromDate">Дата выполнения первой задачи</param>
<param optional="true" name="toDate">Дата выполнения последней задачи</param>
<returns>Список событий</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteHistory(System.Int32)">
<summary>Удаляет событие с указанным в запросе ИД и все связанные с этим событием файлы</summary>
<short>Удалить событие и связанные файлы</short>
<category>История</category>
<param name="id">ИД события</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Событие</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTextFile(System.String,System.Int32,System.String,System.String)">
<summary>Создает текстовый файл (.txt) в выбранной папке с названием и содержимым из отправляемого запроса</summary>
<short>Создать файл txt</short>
<category>Файлы</category>
<param name="entityType">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<param name="title">Заголовок файла</param>
<param name="content">Содержимое файла</param>
<returns>Сведения о файле</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UploadFileInCRM(System.String,System.Int32,System.IO.Stream,System.Net.Mime.ContentType,System.Net.Mime.ContentDisposition,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase},System.Boolean)">
<summary>Загрузить файл</summary>
<short>Загрузить файл</short>
<category>Файлы</category>
2019-02-13 12:12:23 +00:00
<remarks>
<![CDATA[
Загрузку на сервер можно выполнять 2 разными способами:
2019-02-13 12:12:23 +00:00
<ol>
<li>Загрузка одного файла. Необходимо обеспечить указание в заголовках Content-Type/Content-Disposition имени файла и типа контента, а затем отправить файл в теле запроса</li>
<li>С помощью стандартного метода multipart/form-data</li>
2019-02-13 12:12:23 +00:00
</ol>]]>
</remarks>
<param name="entityType">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<param name="file" visible="false">Поток запроса на ввод данных</param>
<param name="contentType" visible="false">Заголовок Content-Type</param>
<param name="contentDisposition" visible="false">Заголовок Content-Disposition</param>
<param name="files" visible="false">Список файлов при публикации в качестве multipart/form-data</param>
<param name="storeOriginalFileFlag" visible="false">Если значение — «True», документы можно также загружать на сервер в исходных форматах</param>
<returns>Сведения о файле</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddHistoryTo(System.String,System.Int32,System.Int32,System.String,System.Int32,ASC.Specific.ApiDateTime,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Создает событие с указанными в запросе параметрами</summary>
<short>Создать событие</short>
<category>История</category>
<param optional="true" name="contactId">ИД контакта</param>
<param optional="true" name="entityType" remark="Allowed values: opportunity or case">Тип связанной сущности</param>
<param optional="true" name="entityId">ИД связанной сущности</param>
2019-02-13 12:12:23 +00:00
<remarks>
<![CDATA[
Обязательно необходимо присвоить значение параметра «contactId», если «entityId» не присвоено значение, или значения параметров «entityId» и «entityType», если «contactId» не присвоено значение.
2019-02-13 12:12:23 +00:00
]]>
</remarks>
<param optional="false" name="content">Содержимое</param>
<param optional="false" name="categoryId">ИД категории</param>
<param optional="true" name="created">Дата создания осбытия</param>
<param optional="true" name="fileId">Список ИД связанных с событием файлов</param>
<param optional="true" name="notifyUserList">Список пользовательских полей</param>
<returns>Созданное событие</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AttachFiles(System.String,System.Int32,System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Связывает выбранные файлы с сущностью, ИД которой указан в запросе</summary>
<short>Связать файл с сущностью</short>
<param name="entityType">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<param name="fileids">Список ИД файлов</param>
<category>Файлы</category>
<returns>Сущность с прикрепленным файлом</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetRootFolderID">
<summary>Возвращает ИД корневой папки, применяемой для хранения файлов для модуля CRM</summary>
<short>Получить ИД корневой папки</short>
<category>Файлы</category>
<returns>ИД корневой папки</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetFiles(System.String,System.Int32)">
<summary>Возвращает список всех файлов для сущности с указанным в запросе ИД или типом</summary>
<param name="entityType">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<short>Получить список файлов</short>
<category>Файлы</category>
<returns>Список файлов</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteCRMFile(System.Int32)">
<summary>Удаляет файл с указанным в запросе ИД</summary>
<short>Удалить файл</short>
<category>Файлы</category>
<param name="fileid">ИД файла</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Сведения о файле</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetEntityTags(System.String,System.Int32)">
<summary>Возвращает список всех связанных с сущностью тегов с указанными в запросе ИД и типом</summary>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<short>Получить теги сущности</short>
<category>Теги</category>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetContactTags(System.Int32)">
<summary>Возвращает список всех тегов для контакта с указанным в запросе ИД</summary>
<param name="contactid">ИД контакта</param>
<short>Получить все теги контакта</short>
<category>Теги</category>
<returns>Список тегов контакта</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTag(System.String,System.String)">
<summary>Создает тег для выбранной сущности с указанным в запросе названием тега</summary>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип сущности</param>
<param name="tagName">Название тега</param>
<short>Создать тег</short>
<category>Теги</category>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetAllTags(System.String)">
<summary>Возвращает список всех тегов, связанных с указанным в запросе типом сущности</summary>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип сущности</param>
<short>Получить теги для типа сущности</short>
<category>Теги</category>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddTagToBatch(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.String)">
<summary>Добавляет группу тегов к сущности с указанным в запросе ИД</summary>
<short>Добавить группу тегов к сущности</short>
<category>Теги</category>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип тега</param>
<param name="entityid">ИД сущности</param>
<param name="tagName">Название тега</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddTagToBatchContacts(System.Collections.Generic.IEnumerable{System.String},System.Int32,System.Int32,ASC.CRM.Core.ContactListViewType,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String)">
<summary>Добавляет выбранный тег к группе контактов с указанными в запросе параметрами</summary>
<short>Добавить тег к группе контактов</short>
<category>Теги</category>
<param optional="true" name="tags">Тег</param>
<param optional="true" name="contactStage">ИД стадии контакта (теплоты отношений)</param>
<param optional="true" name="contactType">ИД типа контакта</param>
2019-02-13 12:12:23 +00:00
<param optional="true" name="contactListView" remark="Allowed values: Company, Person, WithOpportunity"></param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<param name="tagName">Название тега</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddTagToBatchDeals(System.Guid,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.Int32,System.Nullable{ASC.CRM.Core.DealMilestoneStatus},System.Nullable{System.Boolean},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String)">
<summary>Добавляет выбранный тег к группе возможных сделок с указанными в запросе параметрами</summary>
<short>Добавить тег в группу возможных сделок</short>
<category>Теги</category>
<param optional="true" name="responsibleid">Ответственный за возможную сделку</param>
<param optional="true" name="opportunityStagesid">ИД стадии возможной сделки</param>
<param optional="true" name="tags">Теги</param>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="contactAlsoIsParticipant">Статус участия: учитывать возможные сделки, где контакт является участником, или нет</param>
<param optional="true" name="fromDate">Начальная дата</param>
<param optional="true" name="toDate">Конечная дата</param>
<param optional="true" name="stageType" remark="Allowed values: {Open, ClosedAndWon, ClosedAndLost}">Тип стадии возможной сделки</param>
<param name="tagName">Название тега</param>
<exception cref="T:System.ArgumentException"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddTagToBatchCases(System.Int32,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>Добавляет выбранный тег к группе мероприятий с указанными в запросе параметрами</summary>
<short>Добавить тег к группе мероприятий</short>
<category>Теги</category>
<param optional="true" name="contactid">ИД контакта</param>
<param optional="true" name="isClosed">Статус мероприятия</param>
<param optional="true" name="tags">Теги</param>
<param name="tagName">Название тега</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteUnusedTag(System.String)">
<summary>Удаляет все неиспользованные теги из сущностей с указанным в запросе типом</summary>
<short>Удалить неиспользованные теги</short>
<category>Теги</category>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип сущности</param>
<returns>Теги</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddTagTo(System.String,System.Int32,System.String)">
<summary>Добавляет выбранный тег к сущности с указанными в запросе типом и ИД</summary>
<short>Добавить тег</short>
<category>Теги</category>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<param name="tagName">Название тега</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddContactTagToGroup(System.String,System.Int32,System.String)">
<summary>Добавляет выбранный тег к указанной в запросе сущности (компании или персоне) и ко всем связанным контактам</summary>
<short>Добавить тег</short>
<param name="entityType" remark="Allowed values: company,person">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<param name="tagName">Название тега</param>
<category>Теги</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Exception"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTag(System.String,System.String)">
<summary>Удаляет выбранный тег из сущности с указанным в запросе типом</summary>
<short>Удалить тег</short>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип сущности</param>
<param name="tagName">Название тега</param>
<category>Теги</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTagFrom(System.String,System.Int32,System.String)">
<summary>Удаляет выбранный тег из сущности с указанными в запросе типом и ИД</summary>
<short>Убрать тег</short>
<category>Теги</category>
<param name="entityType" remark="Allowed values: contact,opportunity,case">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<param name="tagName">Название тега</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteContactTagFromGroup(System.String,System.Int32,System.String)">
<summary>Удаляет выбранный тег из указанной в запросе сущности (компании или персоны) и изо всех связанных контактов</summary>
<short>Удалить тег</short>
<param name="entityType" remark="Allowed values: company,person">Тип сущности</param>
<param name="entityid">ИД сущности</param>
<param name="tagName">Название тега</param>
<category>Теги</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<exception cref="T:System.Exception"></exception>
<returns>Тег</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskByID(System.Int32)">
<summary>Возвращает подробные сведения о задаче с указанным в запросе ИД</summary>
<param name="taskid">ИД задачи</param>
<returns>Задача</returns>
<short>Получить задачу по ИД</short>
<category>Задачи</category>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetAllTasks(System.Guid,System.Int32,System.Nullable{System.Boolean},ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,System.Int32)">
<summary>Возвращает список задач, соответствующих указанным в запросе критериям</summary>
<param optional="true" name="responsibleid">Ответственный за задачу</param>
<param optional="true" name="categoryid">ИД категории задачи</param>
<param optional="true" name="isClosed">Показывать только открытые или закрытые задачи</param>
<param optional="true" name="fromDate">Дата выполнения первой задачи</param>
<param optional="true" name="toDate">Дата выполнения последней задачи</param>
<param name="entityType" remark="Allowed values: opportunity, contact or case">Тип связанной сущности</param>
<param name="entityid">ИД связанной сущности</param>
<exception cref="T:System.ArgumentException"></exception>
<short>Получить список задач</short>
<category>Задачи</category>
<returns>Список задач</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.ReOpenTask(System.Int32)">
<summary>Снова открыть задачу с указанным в запросе ИД</summary>
<short>Возобновить задачу</short>
<category>Задачи</category>
<param name="taskid">ИД задачи</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Задача</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CloseTask(System.Int32)">
<summary>Закрыть задачу с указанным в запросе ИД</summary>
<short>Закрыть задачу</short>
<category>Задачи</category>
<param name="taskid">ИД задачи</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<returns>Задача</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTask(System.Int32)">
<summary>Удалить задачу с указанным в запросе ИД</summary>
<short>Удалить задачу</short>
<category>Задачи</category>
<param name="taskid">ИД задачи</param>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<returns>Удаленная задача</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTask(System.String,System.String,ASC.Specific.ApiDateTime,System.Guid,System.Int32,System.Int32,System.String,System.Int32,System.Boolean,System.Int32)">
<summary>Создает задачу с указанными в запросе параметрами (названием, описанием, датой выполнения и т. д.)</summary>
<param name="title">Название задачи</param>
<param optional="true" name="description">Описание задачи</param>
<param name="deadline">Дата выполнения задачи</param>
<param name="responsibleId">ИД ответственного за задачу</param>
<param name="categoryId">ИД категории задачи</param>
<param optional="true" name="contactId">ИД контакта</param>
<param optional="true" name="entityType" remark="Allowed values: opportunity or case">Тип связанной сущности</param>
<param optional="true" name="entityId">ИД связанной сущности</param>
<param optional="true" name="isNotify">Уведомить ответственного о задаче</param>
<param optional="true" name="alertValue">Период времени в минутах для напоминания ответственному за задачу о ней</param>
<exception cref="T:System.ArgumentException"></exception>
<short>Создать задачу</short>
<category>Задачи</category>
<returns>Задача</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTaskGroup(System.String,System.String,ASC.Specific.ApiDateTime,System.Guid,System.Int32,System.Int32[],System.String,System.Int32,System.Boolean,System.Int32)">
<summary>Создает группу, состоящую из одних и тех же задач с параметрами (названием, описанием, датой выполнения и т. д.), указанными в запросе для нескольких контактов</summary>
<param name="title">Название задачи</param>
<param optional="true" name="description">Описание задачи</param>
<param name="deadline">Дата выполнения задачи</param>
<param name="responsibleId">ИД ответственного за задачу</param>
<param name="categoryId">ИД категории задачи</param>
<param name="contactId">список ИД контактов</param>
<param optional="true" name="entityType" remark="Allowed values: opportunity or case">Тип связанной сущности</param>
<param optional="true" name="entityId">ИД связанной сущности</param>
<param optional="true" name="isNotify">Уведомить ответственного о задаче</param>
<param optional="true" name="alertValue">Период времени в минутах для напоминания ответственному за задачу о ней</param>
<exception cref="T:System.ArgumentException"></exception>
<short>Создать список задач</short>
<category>Задачи</category>
<returns>Задачи</returns>
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTask(System.Int32,System.String,System.String,ASC.Specific.ApiDateTime,System.Guid,System.Int32,System.Int32,System.String,System.Int32,System.Boolean,System.Int32)">
<summary>Обновляет выбранную задачу, изменяя указанные в запросе параметры (название, описание, дата выполнения и т. д.)</summary>
<param name="taskid">ИД задачи</param>
<param name="title">Название задачи</param>
<param name="description">Описание задачи</param>
<param name="deadline">Дата выполнения задачи</param>
<param name="responsibleid">ИД ответственного за задачу</param>
<param name="categoryid">ИД категории задачи</param>
<param name="contactid">ИД контакта</param>
<param name="entityType" remark="Allowed values: opportunity or case">Тип связанной сущности</param>
<param name="entityid">ИД связанной сущности</param>
<param name="isNotify">Уведомлять или нет</param>
<param optional="true" name="alertValue">Период времени в минутах для напоминания ответственному за задачу о ней</param>
<short>Обновить задачу</short>
<category>Задачи</category>
<returns>Задача</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetTaskCreationDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetTaskLastModifedDate(System.Int32,ASC.Specific.ApiDateTime)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTaskTemplateContainer(System.String,System.String)">
<summary>Создает новый контейнер шаблона задачи с указанными в запросе типом и названием</summary>
<param name="entityType">Тип</param>
<param name="title">Заголовок</param>
<short>Создать контейнер шаблона задачи</short>
<category>Шаблоны задачи</category>
<returns>Контейнер шаблона задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplateContainers(System.String)">
<summary>Возвращает целиком список всех доступных на портале контейнеров шаблона задачи</summary>
<param name="entityType">Тип</param>
<short>Получить список контейнеров шаблона задачи</short>
<category>Шаблоны задачи</category>
<returns>Список контейнеров шаблона задачи</returns>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTaskTemplateContainer(System.Int32)">
<summary>Удаляет контейнер шаблона задачи с указанным в запросе ИД</summary>
<param name="containerid">ИД контейнера шаблона задачи</param>
<short>Удалить контейнер шаблона задачи</short>
<category>Шаблоны задачи</category>
<returns>Удаленный контейнер шаблона задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTaskTemplateContainer(System.Int32,System.String)">
<summary>Обновляет контейнер шаблона задачи, изменяя указанный в запросе ИД</summary>
<param name="containerid">ИД контейнера шаблона задачи</param>
<param name="title">Заголовок</param>
<short>Обновить контейнер шаблона задачи</short>
<category>Шаблоны задачи</category>
<returns>Контейнер шаблона задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplateContainerByID(System.Int32)">
<summary>Возвращает подробные сведения о контейнере шаблона задачи с указанным в запросе ИД</summary>
<param name="containerid">ИД контейнера шаблона задачи</param>
<short>Получить контейнер шаблона задачи по ИД</short>
<category>Шаблоны задачи</category>
<returns>Контейнер шаблона задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplates(System.Int32)">
<summary>Возвращает список всех задач в контейнере с указанным в запросе ИД</summary>
<param name="containerid">ИД контейнера шаблона задачи</param>
<short>Получить список шаблонов задачи по ИД контейнера</short>
<category>Шаблоны задачи</category>
<returns>Список шаблонов задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTaskTemplate(System.Int32,System.String,System.String,System.Guid,System.Int32,System.Boolean,System.Int64,System.Boolean)">
<summary>Создает новый шаблон задачи с указанными в запросе параметрами в контейнере с выбранным ИД</summary>
<param name="containerid">ИД контейнера шаблона задачи</param>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="responsibleid">ИД ответственного</param>
<param name="categoryid">ИД категории</param>
<param name="isNotify">Уведомление ответственного: уведомлять или нет</param>
<param name="offsetTicks">Сдвиг делений</param>
2019-02-13 12:12:23 +00:00
<param name="deadLineIsFixed"></param>
<short>Создать шаблон задачи</short>
<category>Шаблоны задачи</category>
<returns>Шаблон задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTaskTemplate(System.Int32,System.Int32,System.String,System.String,System.Guid,System.Int32,System.Boolean,System.Int64,System.Boolean)">
<summary>Обновляет выбранный шаблон задачи, изменяя указанные в запросе параметры, в контейнере с выбранным ИД</summary>
<param name="id">ИД шаблона задачи</param>
<param name="containerid">ИД контейнера шаблона задачи</param>
<param name="title">Заголовок</param>
<param name="description">Описание</param>
<param name="responsibleid">ИД ответственного</param>
<param name="categoryid">ИД категории</param>
<param name="isNotify">Уведомление ответственного: уведомлять или нет</param>
<param name="offsetTicks">Сдвиг делений</param>
2019-02-13 12:12:23 +00:00
<param name="deadLineIsFixed"></param>
<short>Обновить шаблон задачи</short>
<category>Шаблоны задачи</category>
<returns>Шаблон задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTaskTemplate(System.Int32)">
<summary>Удаляет шаблон задачи с указанным в запросе ИД</summary>
<param name="id">ИД шаблона задачи</param>
<short>Удалить шаблон задачи</short>
<category>Шаблоны задачи</category>
<returns>Шаблон задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplateByID(System.Int32)">
<summary>Возвращает шаблон задачи с указанным в запросе ИД</summary>
<param name="id">ИД шаблона задачи</param>
<short>Получить шаблон задачи по ИД</short>
<category>Шаблоны задачи</category>
<returns>Шаблон задачи</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
2019-02-14 12:43:24 +00:00
<visible>false</visible>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetAvaliableCurrency">
<summary>Возвращает список всех валют, доступных в данный момент на портале</summary>
<short>Получить список валют</short>
<category>Общие</category>
<returns>Список доступных валют</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.ConvertAmount(System.Decimal,System.String,System.String)">
<summary>Возвращает результат обмена одной валюты на другую</summary>
<param name="amount">Обмениваемая сумма</param>
<param name="fromcurrency">Старый код валюты</param>
<param name="tocurrency">Новый код валюты</param>
<short>Получить результат обмена</short>
<category>Общие</category>
<returns>Десятичный результат обмена</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetSummaryTable(System.String)">
<summary>Возвращает сводную таблицу с курсами обмена выбранной валюты</summary>
<param name="currency" remark="Allowed values: EUR, RUB etc. You can get the whole list of available currencies by api">Валюта (аббревиатура)</param>
<short>Получить сводную таблицу</short>
<category>Общие</category>
<returns>Словарь валют и курсов обмена</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCRMContactStatusSettings(System.Nullable{System.Boolean})">
<summary>
</summary>
<param name="changeContactStatusGroupAuto" remark="true, false or null">Автоматически изменять группу статусов контакта</param>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Контакты</category>
<returns>Значение настройки ChangeContactStatusGroupAuto (true, false или пустое)</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCRMWriteMailToHistorySettings(System.Boolean)">
<summary>
</summary>
<param name="writeMailToHistoryAuto" remark="true or false">Автоматически записывать почту в историю</param>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Контакты</category>
<returns>Значение настройки WriteMailToHistoryAuto (true или false)</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCRMContactTagSettings(System.Nullable{System.Boolean})">
<summary>
</summary>
<param name="addTagToContactGroupAuto" remark="true, false or null">автоматически добавлять тег в группу контактов</param>
2019-02-13 12:12:23 +00:00
<short></short>
<category>Контакты</category>
<returns>Значение настройки AddTagToContactGroupAuto (true, false или пустое)</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SetIsPortalConfigured(System.Nullable{System.Boolean},System.Nullable{System.Guid})">
<summary>Задать указанные в запросе настройку владельца IsConfiguredPortal и ключ формы контакта на веб-сайте</summary>
<short>Задать настройки владельца</short>
<category>Общие</category>
<returns>Значение настройки IsConfiguredPortal (true или false)</returns>
2019-02-13 12:12:23 +00:00
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateOrganisationSettingsCompanyName(System.String)">
<summary>Сохранить название компании организации</summary>
<param name="companyName">Название компании организации</param>
<short>Сохранить название компании организации</short>
<category>Организация</category>
<returns>Название компании организации</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
</member>
2019-02-14 12:43:24 +00:00
<member name="M:ASC.Api.CRM.CRMApi.UpdateOrganisationSettingsCompanyAddress(System.String,System.String,System.String,System.String,System.String)">
<summary>Сохранить адрес компании организации</summary>
<param name="street">Адрес компании организации с указанием улицы, дома и офиса</param>
<param name="city">Город</param>
<param name="state">Область</param>
<param name="zip">Почтовый индекс</param>
<param name="country">Страна</param>
<short>Сохранить адрес компании организации</short>
<category>Организация</category>
<returns>Возвращает объект JSON со сведениями об адресе компании организации</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateOrganisationSettingsLogo(System.Boolean)">
<summary>Сохранить логотип организации</summary>
<param name="reset">Сброс логотипа организации</param>
<short>Сохранить логотип организации</short>
<category>Организация</category>
<returns>ИД логотипа организации</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.Exception"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetOrganisationSettingsLogo(System.Int32)">
<summary>Получить логотип организации в формате base64 (если &quot;id&quot; — 0, взять текущий логотип)</summary>
<param name="id">ИД логотипа организации</param>
<short>Получить логотип организации</short>
<category>Организация</category>
<returns>Контент логотипа организации в формате base64</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Exception"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.ChangeWebToLeadFormKey">
<summary>Изменить ключ формы контакта на веб-сайте</summary>
<short>Изменить ключ веб-формы</short>
<category>Общие</category>
<returns>Ключ веб-формы</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateCRMCurrency(System.String)">
<summary>Изменить валюту CRM по умолчанию</summary>
<param name="currency" remark="Allowed values: EUR, RUB etc. You can get the whole list of available currencies by api">Валюта (аббревиатура)</param>
<short>Изменить валюту</short>
<category>Общие</category>
<returns>валюта</returns>
2019-02-13 12:12:23 +00:00
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.StartImportFromCSV(System.String,System.String,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetImportFromCSVStatus(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetImportFromCSVSampleRow(System.String,System.Int32,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.ProcessUploadFake(System.String,System.String)">
<visible>false</visible>
</member>
2019-02-14 12:43:24 +00:00
<member name="M:ASC.Api.CRM.CRMApi.GetExportStatus">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CancelExport">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.StartExport">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetPartialExportStatus">
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
2019-02-14 12:43:24 +00:00
<member name="M:ASC.Api.CRM.CRMApi.CancelPartialExport">
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
2019-02-14 12:43:24 +00:00
<member name="M:ASC.Api.CRM.CRMApi.StartPartialExport(System.String,System.String)">
2019-02-13 12:12:23 +00:00
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetAvailablePhoneNumbers(ASC.VoipService.Twilio.PhoneNumberType,System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetUnlinkedPhoneNumbers">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetExistingPhoneNumbers">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.BuyNumber(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.LinkNumber(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteNumber(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetNumber(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCurrentNumber">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetToken">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateSettings(System.String,System.String,System.String,System.String,System.String,ASC.VoipService.WorkingHours,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateSettings(ASC.VoipService.Queue,System.Boolean)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetVoipSettings">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetUploadedFilesUri">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteUploadedFile(ASC.VoipService.AudioType,System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetOperators(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.AddOperators(System.String,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteOperator(System.String,System.Guid)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateOperator(System.Guid,System.Nullable{ASC.VoipService.AgentStatus},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{ASC.VoipService.AnswerType},System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.MakeCall(System.String,System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.AnswerCall(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.RejectCall(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.ReditectCall(System.String,System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SaveCall(System.String,System.String,System.String,System.Guid,System.Nullable{ASC.VoipService.VoipCallStatus},System.String,System.Nullable{System.Decimal})">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SavePrice(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCalls(System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Nullable{System.Guid},System.Nullable{System.Int32},System.Nullable{System.Int32})">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetMissedCalls">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetCall(System.String)">
<summary>
</summary>
<short></short>
<category>VoIP</category>
2019-02-13 12:12:23 +00:00
<returns></returns>
</member>
<member name="P:ASC.Api.CRM.CRMApi.Name">
<summary>Запись названия API</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.Address">
<summary>Адрес</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.ContactInfoWrapper">
<summary>Информация о контакте</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.PersonWrapper">
<summary>Персона</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.ContactBaseWrapper">
<summary>Сведения о базе контактов</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.CompanyWrapper">
<summary>Компания</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.CurrencyRateWrapper">
<summary>Курс валюты</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.InvoiceBaseWrapper">
<summary>Счет</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.InvoiceWrapper">
<summary>Счет</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.InvoiceItemWrapper">
<summary>Позиция счета</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.InvoiceTaxWrapper">
<summary>Налог счета</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.InvoiceLineWrapper">
<summary>Строка счета</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.InvoiceStatusWrapper">
<summary>Статус счета</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.CurrencyInfoWrapper">
<summary>Сведения о валюте</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.CurrencyRateInfoWrapper">
<summary>Сведения о курсе обмена валюты</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.CustomFieldBaseWrapper">
<summary>Настраиваемые пользовательские поля</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.OpportunityWrapper">
<summary>Возможная сделка</summary>
2019-02-13 12:12:23 +00:00
</member>
<member name="T:ASC.Api.CRM.Wrappers.TaskWrapper">
<summary>Задача</summary>
2019-02-13 12:12:23 +00:00
</member>
</members>
</doc>