Описание
Получить информацию о полях, используемых в базе данных.
URL-адрес
Метод: POST
https://example.com/api/v1.1/databases/fields_get/
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| id | int | 1 | Да | Идентификатор базы данных |
| format | int | "json" | Нет | Формат возвращаемых данных по умолчанию – "json" |
Пример запроса
{
"id": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": [
{
"category": "system",
"title": "Id",
"name": "_id",
"required": true,
"submanager": false,
"type": "unicode",
"enum_values": null
},
{
"category": "default",
"title": "FirstName",
"name": "_fname",
"required": false,
"submanager": false,
"type": "unicode",
"enum_values": null
},
{
"category": "custom",
"title": "Custom_String",
"name": "Custom_String",
"required": false,
"submanager": false,
"type": "unicode",
"enum_values": null
},
{
"category": "custom",
"title": "Custom_Int",
"name": "Custom_Int",
"required": false,
"submanager": false,
"type": "int",
"enum_values": null
},
{
"category": "custom",
"title": "Custom_Bool",
"name": "Custom_Bool",
"required": false,
"submanager": false,
"type": "bool",
"enum_values": null
},
{
"category": "custom",
"title": "Custom_Date",
"name": "Custom_Date",
"required": false,
"submanager": false,
"type": "date",
"enum_values": null
},
{
"category": "custom",
"title": "Custom_Tags",
"name": "Custom_Tags",
"required": false,
"submanager": false,
"type": "tags",
"enum_values": null
},
{
"category": "custom",
"title": "Custom_Enum",
"name": "Custom_Enum",
"required": false,
"submanager": false,
"type": "enum",
"enum_values": [
{
"name": "GMail",
"value": 2
},
{
"name": "HotMail",
"value": 3
},
{
"name": "Yahoo!",
"value": 1
}
]
},
],
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| category | string | Категория поля базы: |
| title | string | Название поля для интерфейса |
| name | string | Название поля для запросов |
| required | bool | Обязательное поле (true) |
| submanager | bool | Поле добавлено в менеджер подписок |
| type | string | Тип поля |
| enum_values | array | Значения полей со списком вариантов |