Создание параметра группы
Пример json данных для HTTP запроса:
{
"title":"Age",
"kind": "numeric"
}
Пример http запроса:
curl -X POST https://api.msndr.net/v1/email/lists/1/parameters \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN' \
-d '...JSON...'
Здесь используется метод POST и ссылка /email/lists/:id/parameters
Если запрос выполнен успешно то вы получите следующий ответ:
{
"id":11,
"title":"Age",
"kind":"numeric",
"list_id":15
}
Ниже в таблице приведено описание параметров данного запроса:
|
Параметр |
Описание |
Обязательный |
|
title |
Да |
|
|
kind |
Возможные значения: |
Ниже приведено описание атрибутов в json ответе:
|
Атрибут |
Описание |
|
id |
Идентификатор |
|
title |
Название |
|
kind |
Тип |
Получение списка параметров группы
Пример HTTP запроса:
curl -X GET https://api.msndr.net/v1/email/lists/1/parameters \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
Здесь используется метод GET и он поддерживает постраничный вывод
Используется ссылка email/lists/:id/parameters
Где id идентификатор группы по которой мы хотим получить список параметров
Пример ответа в случае успешного запроса:
{
"total_count":2,
"total_pages":1,
"page_number":1,
"page_size":25,
"collection":[
{
"id":1,
"title":"Name",
"kind":"string",
"list_id":1
},
{
"id":2,
"title":"Age",
"kind":"numeric",
"list_id":1
}
]
}
Ответ сервера является коллекцией параметров для данной группы. Каждый элемент коллекции содержит атрибуты, описание которых приведено в таблице ниже:
|
Атрибут |
Описание |
|
id |
Идентификатор |
|
title |
Название |
|
kind |
Тип |
Изменение параметра группы
Пример json данных для HTTP запроса:
{
"title":"Age",
"kind": "numeric"
}
Пример HTTP запроса:
curl -X PATCH https://api.msndr.net/v1/email/lists/11/parameters/15 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN' \
-d '...JSON...'
Здесь используется метод PATCH и ссылка /email/lists/:list-id/parameters/:id
где :list-id - уникальный идентификатор группы, :id - идентификатор параметра группы
Пример ответа в случае успешного HTTP запроса:
{
"id":11,
"title":"Age",
"kind":"numeric",
"list_id":15
}
Приведём некоторые пояснения атрибутов запроса в таблице ниже:
|
Параметр |
Описание |
Обязательный |
|
title |
||
|
kind |
Возможные значения: |
Поясним json ответ сервера на HTTP запрос:
|
Атрибут |
Описание |
|
id |
Идентификатор |
|
title |
Название |
|
kind |
Тип |
Удаление параметра у группы
Пример HTTP запроса:
curl -X DELETE https://api.msndr.net/v1/email/lists/11/parameters/15 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
Применяется метод DELETE и ссылка /email/lists/:list-id/parameters/:id
где :list-id – уникальный идентификатор группы, :id - идентификатор параметра
