На этой странице находится старая версия документации Altcraft Platform.
Актуальную информацию вы найдёте, перейдя по ссылке https://guides.altcraft.com.

Описание

Получить информацию о полях, используемых в базе данных.

URL-адрес

Метод: POST

https://example.com/api/v1.1/databases/fields_get/

Параметры запроса

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
idint1ДаИдентификатор базы данных
formatint"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"
}

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
categorystring

Категория поля базы:
system, default, custom

titlestring

Название поля для интерфейса

namestringНазвание поля для запросов
requiredboolОбязательное поле (true)
submanagerboolПоле добавлено в менеджер подписок
typestringТип поля
enum_valuesarray

Значения полей со списком вариантов

  • No labels