You are here: Home / 2015 / Январь / 20 / Automap — rest — CustomFields

Automap — rest — CustomFields

20 января 2015 admin
назад
Automap GS / Руководство разработчика REST / Дополнительные поля

GET /cars/customfields

Структура запроса:


GET /cars/customfields?token=gtr543lpas87

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
	"id": 324,
	"name": "дробное",
	"translit": "drobnoe",
	"format": "float",
	"groupName": "",
	"possibleValues": null,
	"regexp": null,
	"minLength": 0,
	"maxLength": 0,
	"isRequired": false,
	"defaultValue": "123.640",
	"visible": false,
	"order": null
},…]

// id дополнительного поля, целое число
// название дополнительного поля, строка
// транслит названия, строка
// формат данных, строка
// название группы, строка
// возможные значения, строка
// валидация поля, строка
// минимальная длина строки, целое число
// максимальная длина строки, целое число
// является ли поле обязательным, булевое поле
// значение по умолчанию, строка
// отображается ли поле, булевое поле
// порядковый номер, целое число

Примечание:

В зависимости от передаваемого формата данных пользователю становятся доступны определенные поля для добавления и редактирования информации о выбранном дополнительном поле:

  • Строка (string) — валидация поля (regexp), минимальная длина строки (minLength), максимальная длина строки (maxLength), значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
  • Целое число (int) — значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
  • Дробное число (float) — значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
  • Дата (date) — обязательное поле (isRequired), отображение поля (visible).
  • Условие (bool) — значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
  • Список (list) — возможные значения списка (possibleValues), значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

POST /cars/customfields

Структура запроса:


POST /cars/customfields?token=gtr543lpas87

token: ключ доступа

Пример запроса:

Формат: json

{
	"defaultValue": 10,
	"format": "int",
	"isRequired": true,
	"name": "Новое поле",
	"visible": true
}

// значение по умолчанию, строка
// формат данных, строка
// является ли поле обязательным, булевое поле
// название дополнительного поля, строка
// отображается ли поле, булевое поле

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 822,
	"name": "Новое поле",
	"translit": "Novoe_pole",
	"format": "string",
	"groupName": "",
	"possibleValues": null,
	"regexp": "Регулярное выражение",
	"minLength": 0,
	"maxLength": 225,
	"isRequired": true,
	"defaultValue": null,
	"visible": true,
	"order": null
}

// id дополнительного поля, целое число
// название дополнительного поля, строка
// транслит названия, строка
// формат данных, строка
// название группы, строка
// возможные значения, строка
// валидация поля, строка
// минимальная длина строки, целое число
// максимальная длина строки, целое число
// является ли поле обязательным, булевое поле
// значение по умолчанию, строка
// отображается ли поле, булевое поле
// порядковый номер, целое число

Статус: 400 — ошибка в запросе

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

PUT /cars/customfields/{id}

Структура запроса:


PUT /cars/customfields/82?token=gtr543lpas87

id: id дополнительного поля

token: ключ доступа

Пример запроса:

Формат: json

{
	"id": 82,
	"name": "Дополнительное поле",
	"translit": "Dopolnitelnoe_pole",
	"format": "list",
	"groupName": "",
	"possibleValues": ["значение 1"],
        "regexp": null,
	"minLength": 0,
	"maxLength": 0,
	"isRequired": true,
	"defaultValue": "значение 1",
	"visible": true,
	"order": null
}

// id дополнительного поля, целое число
// название дополнительного поля, строка
// транслит названия, строка
// формат данных, строка
// название группы, строка
// возможные значения, строка
// валидация поля, строка
// минимальная длина строки, целое число
// максимальная длина строки, целое число
// является ли поле обязательным, булевое поле
// значение по умолчанию, строка
// отображается ли поле, булевое поле
// порядковый номер, целое число

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 82,
	"name": "Дополнительное поле",
	"translit": "Dopolnitelnoe_pole",
	"format": "list",
	"groupName": "",
	"possibleValues": ["значение 1"],
	"regexp": null,
	"minLength": 0,
	"maxLength": 0,
	"isRequired": true,
	"defaultValue": "значение 1",
	"visible": true,
	"order": null
}

// id дополнительного поля, целое число
// название дополнительного поля, строка
// транслит названия, строка
// формат данных, строка
// название группы, строка
// возможные значения, строка
// валидация поля, строка
// минимальная длина строки, целое число
// максимальная длина строки, целое число
// является ли поле обязательным, булевое поле
// значение по умолчанию, строка
// отображается ли поле, булевое поле
// порядковый номер, целое число

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

DELETE /cars/customfields/{id}

Структура запроса:


DELETE /cars/customfields/82?token=gtr543lpas87

id: id дополнительного поля

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Posted in