Módulo customfield

Este modulo agrupa servicios de administración de los campos personalizados utilizados para la información de los contactos y los formularios de suscripción.

1.Listar campos personalizados

Servicio:

/customfield/list

Lista los campos personalizados que han sido configurados

Parámetros:

Parámetrocount
RequeridoNO
TipoNúmero Entero
ExplicaciónNúmero de registros como máximo por página
Ejemplocount=10
Parámetroabsolutepage
RequeridoNO
TipoNúmero Entero
ExplicaciónPágina de "count" registros a la que se quiere ir. Si count vale 10 y absolutepage vale 3, entonces empezaremos a ver desde el registro 31
Ejemploabsolutepage=3
Parámetrofilter
RequeridoNO
TipoCadena de caracteres
ExplicaciónNombre o parte del nombre por el que se filtran los registros
Ejemplofilter=Promo Verano
ParámetroorderBy
RequeridoNO
Tipo[name|id]
ExplicaciónCampo por el cual estará ordenado el listado
EjemploorderBy=Id
Parámetrodesc
RequeridoNO
Tipo[1|0]
ExplicaciónDetermina si el orden del listado es ascendente (0) o descendente (1)
Ejemplodesc=1

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requerido

Estructura de Salida:

list.item.CustomFieldID
ID del registro (campo personalizado)
list.item.FieldType
Tipo de campo personalizado:
'Text field' Campo de texto
'Password field' Campo de contraseña
'Hidden field' Campo oculto
'Notice' Bloque informativo
'Text area' Campo de texto multilínea
'Check box' Opciones de selección múltiple
'Radio button' Opciones de selección única
'List' Listado de selección múltiple
'Drop list' Listado de selección única
list.item.Validation
Tipo de validación de datos que acepta el campo:
'Do not Apply' No validar (opción por defecto)
'Numeric Only' Aceptar solo dígitos (sin espacios)
'Alpha Only' Aceptar solo letras y espacios
'Alpha Numeric Only' Aceptar solo letras, números y espacios
'Email Format Check' Aceptar solo direcciones de Email
'Custom' Personalizado (requiere que sea configurada una exporesión regular personalizada de validación)
list.item.ValidationCustomRegExp
Expresión regular personalizada utilizadao para validar los datos del campo
list.item.IsMultipleSelect
Indica si acepta valores múltimples
list.item.Values.Option
Arreglo de valores que el campo posee

2.Crear o Modificar la información de un campo personalizado

Servicio:

/customfield/edit

Recupera, crea o edita los atributos de un campo personalizado. Si el llamado al servicio es por GET, recupera la información del registro solicitado. Si es por POST Crea o actualiza (si se ingresa el parametro CustomFieldID) los datos del registro

Parámetros:

ParámetroCustomFieldID
RequeridoNO
TipoNúmero Entero
ExplicaciónID del registro
EjemploEmailID=2
ParámetroTitle
RequeridoSi (Solo por POST)
TipoCadena de caracteres
ExplicaciónEtiqueta o nombre del campo personalizado
EjemploTitle=Color
ParámetroFieldType
RequeridoSi (Solo por POST)
TipoCadena de caracteres
ExplicaciónTipo de campo personalizado
EjemploFieldType=List
ParámetroValidation
RequeridoNO
TipoCadena de caracteres
ExplicaciónTipo de validación de datos que acepta el campo
EjemploValidation=Custom
ParámetroValidationCustomRegExp
RequeridoSi (Solo si el parámetro Validation es de tipo Custom)
TipoCadena de caracteres
ExplicaciónExpresión regular personalizada utilizadao para validar los datos del campo
EjemploValidationCustomRegExp=/^[a-zA-Z0-9]*$/
ParámetroDefaultValue
RequeridoNO
TipoCadena de caracteres
ExplicaciónValores por defecto que posee el campo (utilizado solo en campos Text field, Password field, Text area, Notice y Hidden field)
EjemploDefaultValue=0800MiTelefono
ParámetroItemsNames
RequeridoNO
TipoArreglo
ExplicaciónListado de etiquetas de las opciones del campo (utilizado solo en campos tipo List, Drop list, Radio button y Check box) [ver nota]
EjemploItemsNames[]=Rojo&ItemsNames[]=Blanco
ParámetroItemsValues
RequeridoNO
TipoArreglo
ExplicaciónListado de valores de las opciones del campo (utilizado solo en campos tipo List, Drop list, Radio button y Check box) [ver nota]
EjemploItemsValues[]=red&ItemsValues[]=white
ParámetroItemsSelectedValues
RequeridoNO
TipoArreglo
ExplicaciónListado de las opciones del campo marcadas como seleccionadas (utilizado solo en campos tipo List, Drop list, Radio buttony Check box)
EjemploItemsSelectedValues[]=white
ParámetroItemsIsMultipleSelect
RequeridoNO
TipoEntero [1|0]
ExplicaciónIndica si el campo acepta múltiples valores
EjemploItemsIsMultipleSelect=1

Nota: Los parámetros ItemsNames eItemsValues están relacionados entre sí a través de la correspondencia de las claves de ambos arreglos. Ej. ItemsNames[5] posee la etiqueta de la opción cuyo valor se encuentra indicado en ItemsValues[5]

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requeridos
errorMsg_customfieldNotFound
El registro solicitado no se encuentra

Estructura de salida:

customField.CustomFieldID
ID del registro (campo personalizado)
customField.Title
Etiqueta/nombre del campo
customField.FieldType
Tipo de campo personalizado
customField.Validation
Tipo de validación de datos que acepta el campo
customField.ValidationCustomRegExp
Expresión regular personalizada utilizadao para validar los datos del campo
customField.IsMultipleSelect
Indica si acepta valores múltimples
customField.Values.Option
Arreglo de valores que el campo posee

** Solo se documentan los campos mas relevantes.

3.Borrar un campo personalizado

Servicio:

/customfield/delete

Elimina definitivamente un campo personalizado, el registro no estará más disponible para su utilización

Parámetros:

ParámetroCustomFieldIds
RequeridoSI
TipoArreglo de números enteros
ExplicaciónID de los registros que se desea eliminar
EjemploCustomFieldIds[]=2&CustomFieldIds[]=5

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requeridos
errors.notDeleted
Arreglo de IDs de registro que no han podido ser eliminados

Estructura de salida:

countDeleted
Número de registros eliminados satisfactoriamente
countNotDeleted
Número de registros que no han podido ser eliminados