Дополнительные поля

С помощью API вы можете создавать, редактировать и удалять дополнительные поля ваших списков.
Базовый URL: http://api.mailhandler.ru/sub/fields/​
Получение списка полей
Отправьте GET запрос на URL http://api.mailhandler.ru/sub/fields/. Запрос не должен содержать параметров. В результате вы получите ответ в формате JSON со списком созданных вами дополнительных полей.
Bash
Python
Пример получения списка объектов с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/fields/' \ 
2
-X GET \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения списка объектов на python:
1
import requests 
2
​
3
def get_list():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }      
9
    response = requests.get('http://api.mailhandler.ru/sub/fields/',                              
10
                  json=data, 
11
                  headers=headers)     
12
    print(response.status_code)
Copied!
В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK
1
{
2
  "count": 1,
3
  "next": null,
4
  "previous": null,
5
  "results": [
6
    {
7
        "id": 636,
8
        "variable": "surname",
9
        "name": "Фамилия",
10
        "date_created": "2017-03-15T10:21:56.854530"
11
    }]
12
}
Copied!
Создание поля
Отправьте POST запрос на URL http://api.mailhandler.ru/sub/fields/. Запрос должен содержать следующие параметры:
Название
Описание
Обязателен
Пример
variable
Название переменной
Да
surname
name
Человеко-понятное имя переменной
Да
Фамилия
В результате успешного создания объекта вы получите ответ в формате JSON с данными созданного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
variable
Название переменной
surname
name
Человеко-понятное имя переменной
Фамилия
date_created
Дата создания списка
2017-03-15T10:21:56.854530
Bash
Python
Пример создания объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/fields/' \ 
2
-X POST \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
5
-d '{"variable":"surname", "name":"Фамилия"}'
Copied!
Пример создания объекта на python:
1
import requests 
2
​
3
def create():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    data = {         
10
        'variable': 'surname',         
11
        'name': 'Фамилия'
12
    }     
13
    response = requests.post('http://api.mailhandler.ru/sub/fields/',                              
14
                  json=data, 
15
                  headers=headers)     
16
    print(response.status_code)
Copied!
В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created
1
{
2
  "id": 636,
3
  "variable": "surname",
4
  "name": "Фамилия",
5
  "date_created": "2017-03-15T10:21:56.854530"
6
}
Copied!
Редактирование поля
Отправьте PUT или PATCH запрос на URL http://api.mailhandler.ru/sub/fields/{field_id}/, где field_id - идентификатор нужного вам поля.
Запрос может содержать следующие параметры:
Название
Описание
Обязателен
Пример
variable
Название переменной
Да
surname
name
Человеко-понятное имя переменной
Да
Фамилия
В результате успешного создания объекта вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
variable
Название переменной
surname
name
Человеко-понятное имя переменной
Фамилия
date_created
Дата создания списка
2017-03-15T10:21:56.854530
Bash
Python
Пример редактирования объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/fields/100' \ 
2
-X PATCH \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
5
-d '{"variable":"birth_date"}'
Copied!
Пример редактирования объекта на python:
1
import requests 
2
​
3
def edit():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    data = {         
10
        'variable': 'birth_date'
11
    }     
12
    response = requests.patch('http://api.mailhandler.ru/sub/fields/100/',                              
13
                  json=data, 
14
                  headers=headers)     
15
    print(response.status_code)
Copied!
В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
  "id": 636,
3
  "variable": "surname",
4
  "name": "Фамилия",
5
  "date_created": "2017-03-15T10:21:56.854530"
6
}
Copied!
Получение данных поля
Отправьте GET запрос на URL http://api.mailhandler.ru/sub/fields/{field_id}/, где field_id - идентификатор нужного вам поля.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
variable
Название переменной
surname
name
Человеко-понятное имя переменной
Фамилия
date_created
Дата создания списка
2017-03-15T10:21:56.854530
Bash
Python
Пример получения данных объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/fields/100' \ 
2
-X GET \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения данных объекта на python:
1
import requests 
2
​
3
def get():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    response = requests.get('http://api.mailhandler.ru/sub/fields/100/',
10
                  headers=headers)     
11
    print(response.status_code)
Copied!
В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
  "id": 100,
3
  "variable": "surname",
4
  "name": "Фамилия",
5
  "date_created": "2017-03-15T10:21:56.854530"
6
}
Copied!
Удаление поля
Отправьте DELETE запрос на URL http://api.mailhandler.ru/sub/fields/{field_id}/, где field_id - идентификатор нужного вам поля.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ со статусом 204 No Content.
Bash
Python
Пример удаления списка с помощью curl:
1
curl 'http://api.mailhandler.ru/sub/fields/100' \ 
2
-X DELETE \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример удаления объекта на python:
1
import requests 
2
​
3
def delete():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    response = requests.delete('http://api.mailhandler.ru/sub/fields/100/',
10
                  headers=headers)     
11
    print(response.status_code)
Copied!
Подписчики - Previous
Списки
Next - Подписчики
Подписчики
Last modified 3yr ago
Copy link
Contents
Получение списка полей
Создание поля
Редактирование поля
Получение данных поля
Удаление поля