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