~~NOTOC~~
==== Список запросов ====
^ Запрос ^ Описание ^
| [[#checknumber_elementlist|checknumber/element.list]] | Получает список элементов "Проверка по шаблону" |
| [[#checknumber_elementget|checknumber/element.get]] | Получает параметры элемента "Проверка по шаблону" |
| [[#checknumber_elementadd|checknumber/element.add]] | Добавляет новый элемент "Проверка по шаблону" |
| [[#checknumber_elementedit|checknumber/element.edit]] | Изменяет параметры элемента "Проверка по шаблону" |
| [[#checknumber_elementdel|checknumber/element.del]] | Удаляет элемент "Проверка по шаблону" |
| [[#checknumber_elementnumberlist|checknumber/element.number.list]] | Получает список шаблонов из элемента "Проверка по шаблону" |
| [[#checknumber_elementnumberget|checknumber/element.number.get]] | Получает параметры шаблона из элемента "Проверка по шаблону" |
| [[#checknumber_elementnumberadd|checknumber/element.number.add]] | Добавляет новый шаблон в элемент "Проверка по шаблону" |
| [[#checknumber_elementnumberedit|checknumber/element.number.edit]] | Изменяет шаблон в элементе "Проверка по шаблону" |
| [[#checknumber_elementnumberdel|checknumber/element.number.del]] | Удаляет шаблон из элемента "Проверка по шаблону" |

----

==== checknumber/element.list ====
Получает список элементов "Проверка по шаблону"\\
\\
**Параметры запроса:**\\
Нет \\
\\
**Возврат**: Массив объектов в формате json
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
  * **elementName** - Название элемента "Проверка по шаблону"
  * **elementExten** - Не используется

----

==== checknumber/element.get ====
Получает параметры элемента "Проверка по шаблону"\\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
**Возврат**: Объект в формате json
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
  * **elementName** - Название элемента "Проверка по шаблону"
  * **elementExten** - Не используется
  * **numberType** - Тип сравниваемого номера. 'caller'- определившийся номер,  'called' - набранный номер

----

==== checknumber/element.add ====
Добавляет новый элемент "Проверка по шаблону"\\
\\
**Параметры запроса:**
  * **elementName** - Название элемента "Проверка по шаблону"
  * **numberType** - Тип сравниваемого номера. 'caller'- определившийся номер,  'called' - набранный номер
**Возврат:**\\ Идентификатор нового элемента "Проверка по списку"

----

==== checknumber/element.edit ====
Изменяет параметры элемента "Проверка по шаблону" \\
\\
**Параметры запроса:** 
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
  * **elementName** - Название элемента "Проверка по шаблону"
  * **numberType** - Тип сравниваемого номера. 'caller'- определившийся номер,  'called' - набранный номер
**Возврат:** - Булево 

----

==== checknumber/element.del ====
Удаляет элемент "Проверка по шаблону" \\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Проверка по шаблону"  для удаления
**Возврат:** - Булево 

----

==== checknumber/element.number.list ====
Получает список шаблонов из элемента "Проверка по шаблону"\\
\\
**Параметры запроса:**\\
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
**Возврат**: Массив объектов в формате json
  * **template_id** - Идентификатор шаблона в элементе "Проверка по шаблону"
  * **template** - Строковый шаблон для проверки номера в формате regexp
  * **description** - Описание шаблона
  * **trim** - Кол-во символов которые необходимо отрезать сначала номера, если он совпадает с шаблоном
  * **prefix** - Символы которые нужно добавить в начало номера, если он совпадает с шаблоном

----

==== checknumber/element.number.get ====
Получает параметры шаблона из элемента "Проверка по шаблону"\\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
  * **template_id** - Идентификатор шаблона в элементе "Проверка по шаблону"
**Возврат**: Объект в формате json
  * **template_id** - Идентификатор шаблона в элементе "Проверка по шаблону"
  * **template** - Строковый шаблон для проверки номера в формате regexp
  * **description** - Описание шаблона
  * **trim** - Кол-во символов которые необходимо отрезать сначала номера, если он совпадает с шаблоном
  * **prefix** - Символы которые нужно добавить в начало номера, если он совпадает с шаблоном

----

==== checknumber/element.number.add ====
Добавляет новый шаблон в элемент "Проверка по шаблону" \\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
  * **template** - Строковый шаблон для проверки номера в формате regexp
  * **description** - Описание шаблона
  * **trim** - Кол-во символов которые необходимо отрезать сначала номера, если он совпадает с шаблоном
  * **prefix** - Символы которые нужно добавить в начало номера, если он совпадает с шаблоном

**Возврат**: Объект в формате json. Совпадает с возвратом [[#checknumber_elementnumberget|checknumber/element.number.get]]

----

==== checknumber/element.number.edit ====
Изменяет шаблон в элементе "Проверка по шаблону"\\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
  * **template_id** - Идентификатор шаблона в элементе "Проверка по шаблону"
  * **template** - Строковый шаблон для проверки номера в формате regexp
  * **description** - Описание шаблона
  * **trim** - Кол-во символов которые необходимо отрезать сначала номера, если он совпадает с шаблоном
  * **prefix** - Символы которые нужно добавить в начало номера, если он совпадает с шаблоном
**Возврат**: Объект в формате json. Совпадает с возвратом [[#checknumber_elementnumberget|checknumber/element.number.get]]

----

==== checknumber/element.number.del ====
Удаляет шаблон из элемента "Проверка по шаблону" \\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Проверка по шаблону"
  * **template_id** - Идентификатор шаблона в элементе "Проверка по шаблону"
**Возврат**- Булево