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

С помощью API вы можете создавать, редактировать и удалять дополнительные поля ваших списков.

Базовый URL: http://api.mailhandler.ru/sub/fields/

Получение списка полей

Отправьте GET запрос на URL http://api.mailhandler.ru/sub/fields/. Запрос не должен содержать параметров. В результате вы получите ответ в формате JSON со списком созданных вами дополнительных полей.

Bash
Python
Bash

Пример получения списка объектов с помощью curl:

curl 'http://api.mailhandler.ru/sub/fields/' \
-X GET \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Python

Пример получения списка объектов на python:

import requests
def get_list():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.get('http://api.mailhandler.ru/sub/fields/',
json=data,
headers=headers)
print(response.status_code)

В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 636,
"variable": "surname",
"name": "Фамилия",
"date_created": "2017-03-15T10:21:56.854530"
}]
}

Создание поля

Отправьте 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
Bash

Пример создания объекта с помощью curl:

curl 'http://api.mailhandler.ru/sub/fields/' \
-X POST \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>' \
-d '{"variable":"surname", "name":"Фамилия"}'
Python

Пример создания объекта на python:

import requests
def create():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = {
'variable': 'surname',
'name': 'Фамилия'
}
response = requests.post('http://api.mailhandler.ru/sub/fields/',
json=data,
headers=headers)
print(response.status_code)

В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created

{
"id": 636,
"variable": "surname",
"name": "Фамилия",
"date_created": "2017-03-15T10:21:56.854530"
}

Редактирование поля

Отправьте 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
Bash

Пример редактирования объекта с помощью curl:

curl 'http://api.mailhandler.ru/sub/fields/100' \
-X PATCH \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>' \
-d '{"variable":"birth_date"}'
Python

Пример редактирования объекта на python:

import requests
def edit():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = {
'variable': 'birth_date'
}
response = requests.patch('http://api.mailhandler.ru/sub/fields/100/',
json=data,
headers=headers)
print(response.status_code)

В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK

{
"id": 636,
"variable": "surname",
"name": "Фамилия",
"date_created": "2017-03-15T10:21:56.854530"
}

Получение данных поля

Отправьте 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
Bash

Пример получения данных объекта с помощью curl:

curl 'http://api.mailhandler.ru/sub/fields/100' \
-X GET \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Python

Пример получения данных объекта на python:

import requests
def get():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.get('http://api.mailhandler.ru/sub/fields/100/',
headers=headers)
print(response.status_code)

В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK

{
"id": 100,
"variable": "surname",
"name": "Фамилия",
"date_created": "2017-03-15T10:21:56.854530"
}

Удаление поля

Отправьте DELETE запрос на URL http://api.mailhandler.ru/sub/fields/{field_id}/, где field_id - идентификатор нужного вам поля.

Запрос не должен содержать параметров.

В результате успешного запроса вы получите ответ со статусом 204 No Content.

Bash
Python
Bash

Пример удаления списка с помощью curl:

curl 'http://api.mailhandler.ru/sub/fields/100' \
-X DELETE \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Python

Пример удаления объекта на python:

import requests
def delete():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.delete('http://api.mailhandler.ru/sub/fields/100/',
headers=headers)
print(response.status_code)