Módulo mailist

Este modulo agrupa servicios de administración de listas de contactos.

1.Listar listas de contactos

Servicio:

/maillist/list

Lista todas las listas de contactos

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
TipoCadena de caracteres posibles:
  • name (nombre de la lista)
  • activememberscount (cantidad de miembros activos)
  • memberscount (cantidad de miembros totales)
ExplicaciónCampo por el cual estará ordenado el listado
EjemploorderBy=name
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
errorMsg_noMaillist
No se pudieron recuperar las listas de contactos

Estructura de Salida:

list.item.MailListID
ID de lista de contacto
list.item.Name
Nombre de la lista de contactos
list.item.MemberCount
Total de contactos (suscriptos y desuscriptos)
list.item.ActiveMembersCount
Total de contactos suscriptos o pendientes de de-suscripción
SubscriptionType
[Opt-in (necesita confirmación de suscripción) | Free (suscripción sin confirmación)]

2.Crear o Modificar la información de una Lista de Contactos

Servicio:

/maillist/edit

Recupera, crea o edita los atributos de una lista de contactos. Si el llamado al servicio es por GET, recupera la información de la lista solicitada. Si es por POST Crea o actualiza (si se ingresa el parametro MailListID) el nombre de la lista de contactos

Parámetros:

ParámetroMailListID
RequeridoNO
TipoNúmero Entero
ExplicaciónID de lista de contactos
EjemploMailListID=2
ParámetroMailListName
RequeridoSi (Solo por POST)
TipoNúmero Entero
ExplicaciónCadena de caracteres
EjemploMailListName=Mi lista de contactos

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requeridos
errorMsg_maillistNotFound
La lista solicitada no se encuentra
errorMsg_maillistNotEdited
No se pudo editar la lista de contactos

Estructura de Salida:

maillist.MailListID
ID de lista de contacto
maillist.MailListName
Nombre de la lista de contactos

** Solo se documentan los campos mas relevantes.