Diferencia entre revisiones de «Servicios Web»

De wiki
Saltar a: navegación, buscar
Línea 16: Línea 16:
 
</pre>
 
</pre>
  
El resultado será un json parecido a este
+
En caso de éxito el resultado será un json parecido a este:
  
 
<pre>
 
<pre>
Línea 32: Línea 32:
 
     'deletedBy' : null,
 
     'deletedBy' : null,
 
   }
 
   }
 +
}
 +
</pre>
 +
 +
En caso de error el resultado será un json parecido a este:
 +
 +
<pre>
 +
{
 +
  'errors' : {
 +
    'description' : "descripción está vacía",
 +
    'thingyId' : "nota no está relacionada con ningún objeto"
 +
  },
 +
  'error' : true
 
}
 
}
 
</pre>
 
</pre>

Revisión de 19:50 21 dic 2010

NiMbox permite acceder ciertas de sus funcionalidades a través de servicios web. El punto de contacto de estos sitios web es la dirección segura https://host/direct/items. Los servicios web disponibles por el momento son:

Agregar una nota

Es posible agregar notas a cualquiera de los elementos de datos representados en NiMbox. Los parámetros son:

thingyId
el elemento al cual conectarle la nota. Típicamente este elemento es un contacto.
contextName (opcional)
el nombre del contexto al cual conectarle la nota.
description
el contenido de la nota.

Para crear una nota

wget --user=jlopez --password=comic -qO- \
  "http://host/direct/items/notes/create?thingyId=24&description=La+nota+se+proceso+exitosamente"

En caso de éxito el resultado será un json parecido a este:

{
  'error' : false,
  'note' : {
    'id' : 34044,
    'description' : "La nota se proceso exitosamente",
    'sortDate' : new Date(2010,11,21,7,5,36),
    'createdOn' : new Date(2010,11,21,7,5,36),
    'createdBy' : "jlopez",
    'updatedOn' : new Date(2010,11,21,7,5,36),
    'updatedBy' : "jlopez"
    'deletedOn' : null,
    'deletedBy' : null,
  }
}

En caso de error el resultado será un json parecido a este:

{
  'errors' : {
    'description' : "descripción está vacía",
    'thingyId' : "nota no está relacionada con ningún objeto"
  },
  'error' : true
}