CustomField.Create
Описание
Создать новое дополнительное поле для указанного списка
Параметры запроса
- SessionID = {string} (обязательный)
- Session ID необходим для аутентификации. Обязателен только для десктоп приложений
- Command = {CustomField.Create} (обязательный)
- API команда
- ResponseFormat = {JSON | XML} (обязательный)
- Формат ответа
- JSONPCallBack = {bool}
- Используется для междоменной передачи. Узнать о JSONP можно по ссылке: http://ru.wikipedia.org/wiki/JSONP
- SubscriberListID = {integer} (обязательный)
- ID списка
- PresetName = {Gender | Age | Employment | Income | Education | Days of the week | Months of the year | U.S. states | Continents | Satisfaction | Importance | Agreement | Comparison}
- Можете использовать пресет для создания дополнительного поля.
- FieldName = {string} (обязательный)
- Название дополнительного поля
- FieldType = {Single line | Paragraph text | Multiple choice | Drop down | Checkboxes | Hidden field} (обязательный)
- Тип дополнительного поля
- FieldDefaultValue = {string} (обязательный)
- Значение дополнительного поля по умолчанию
- OptionLabel[n] = {string} (обязательный)
- подпись для варианта N
- OptionValue[n] = {string} (обязательный)
- значение для варианта N
- OptionSelected = {array} (обязательный)
- Массив выбранных id опций (id опции n)
- ValidationMethod = {Disabled | Numbers | Letters | Numbers and letters | Email address | URL | Date | Time | Custom} (обязательный)
- Способ валидации дополнительного поля
- ValidationRule = {string} (обязательный)
- Правило валидации дополнительного поля
- Visibility = {Public | User Only}
- Показывать ли дополнительное поле в кабинете подписчика
- IsRequired = {Yes | No}
- Обязательно ли заполнять дополнительное поле
- IsUnique = {Yes | No}
- Должно ли быть уникальным значение дополнительного поля
- IsGlobal = {Yes | No}
- Если установлено 'Yes', дополнительное поле будет доступно для всех списков пользователя
Параметры ответа
- Success = {true | false}
- Состояние - успешно или ошибка
- ErrorCode = {integer}
- Код ошибки
- CustomFieldID = {integer}
- ID дополнительного поля
Коды ошибок
- 1
- ID списка подписчиков не найден
- 2
- Название дополнительного поля не указано
- 3
- Тип поля не найден
- 4
- Правило валидации не указано
- 5
- Недействительное название пресета
- 99998
- Ошибка авторизации или истекла сессия
- 99999
- Недостаточно прав
