
1. Descripción
La API PHP de la Agenda de Contactos te permite tener un acceso total a todos tus contactos almacenados en tu cuenta.
Podrás gestionar tus contactos para crear nuevos, eliminar y modificar.
2. Documentación
Llamada
La clase dispone de una llamada para obtener los contactos de su Agenda:
Esta llamada requiere de un argumento, que será una instancia de la clase dms_filtro, esta clase tiene las siguientes propiedades:
Nombre Parámetro |
Descripción |
Posibles Valores |
Tipo de Dato |
| nfilas |
Número de contactos a obtener |
1, 2, 3, ..
|
Int |
| ndesde |
Desde que contacto empezaremos a obtener el listado (páginado) |
1, 2, 3, .. |
Int |
| ordencampo |
Nombre del campo por el que ordenaremos la lista. |
id, nombre, apellidos, numero, ...
|
String |
Esta clase dispone de una funcíon para establecer condiciones en la consulta, de forma que podamos obtener contactos según unos criterios de busqueda.
Esta función es:
agregarBusqueda ($campo,$valor,$operador);
Nombre Parámetro |
Descripción |
Posibles Valores |
Tipo de Dato |
| $campo |
Nombre del campo del cual vamos a relizar la buscar |
id, nombre, apellidos, numero, ...
|
String |
| $valor |
Parte que vamos a buscar en el campo |
|
String |
| $operador |
Operador de la busqueda |
- EQ; igual que
- NEQ; distinto que
- IN; Contiene
- NIN; No Contiene
- GET; Mayor o Igual que
- LEQ; Menor o Igual que
|
String |
Resultado
Una vez realizada la llamada de busqueda de contactos, obtendremos el resultado del proceso, a tráves de la subclase:
contactos
Esta clase tiene la siguiente estructura:
- ntotal; Número de contactos existentes en la agenda según los criterios del filtro.
- nfilas; Número de contactos obtenido en esta consulta
- ndesde; Número de contactos desde el que se obtiene la consulta
- contactos; Es un Array donde cada elemento es de una clase dms_contact, que a su vez, dispone de todos los datos del contacto, esta es la definición de clase:
class dms_contact
{
var $n;
var $id;
var $numero;
var $nombre;
var $apellidos;
var $tratamiento;
var $alias;
var $sexo;
var $localizacion;
var $etiqueta;
var $nota;
var $cp;
var $fnac;
var $empresa;
var $operador;
var $tienecasa;
var $tienehijos;
var $tienecoche;
var $marca;
var $modelo;
}
3. Ejemplo
include_once ("class_dms.php");
$dms=new dms_send;
//Autentificar
$dms->autentificacion->idcli="codigo cliente";
$dms->autentificacion->username="nombre de usuario";
$dms->autentificacion->passwd="password";
$dms->SupportSSL(true);
//Definir filtro
$filtro=new dms_filtro;
$filtro->nfilas=25;
$filtro->ndesde=1;
$filtro->ordencampo='nombre';
//Solo buscar usuario que contengan en el nombre la letra a
//$filtro->agregarBusqueda('nombre','a','IN');
//Enviar solicitud a la plataforma
$dms->getContacts($filtro);
//Verificar Resultado
if ($dms->autentificacion->error){
//Error de autentificacion con la plataforma
echo $dms->autentificacion->mensajeerror."\n";
}else{
echo "NTotal: ".$dms->contactos->ntotal."\n";
echo "NFilas: ".$dms->contactos->nfilas."\n";
echo "NDesde: ".$dms->contactos->ndesde."\n";
echo "\n";
echo "N;ID;NUMERO;NOMBRE;APELLIDOS;TRATAMIENTO;ALIAS;SEXO;LOCALIZACION;ETIQUETA;NOTA;CP;FNAC;EMPRESA;OPERADOR;TIENECASA;TIENEHIJOS;TIENECOCHE;MARCA;MODELO\n";
foreach ($dms->contactos->contactos as $contacto){
echo $contacto->n.";";
echo $contacto->id.";";
echo $contacto->numero.";";
echo $contacto->nombre.";";
echo $contacto->apellidos.";";
echo $contacto->tratamiento.";";
echo $contacto->alias.";";
echo $contacto->sexo.";";
echo $contacto->localizacion.";";
echo $contacto->etiqueta.";";
echo $contacto->nota.";";
echo $contacto->cp.";";
echo $contacto->fnac.";";
echo $contacto->empresa.";";
echo $contacto->operador.";";
echo $contacto->tienecasa.";";
echo $contacto->tienehijos.";";
echo $contacto->tienecoche.";";
echo $contacto->marca.";";
echo $contacto->modelo.";";
echo "\n";
}
}
4. Gráfico
