Servicios Web
De wiki
Revisión a fecha de 17:44 22 dic 2010; Rmarimon (Discusión | contribuciones)
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' : { 'thingyId' : "nota no está relacionada con ningún objeto" 'description' : "descripción está vacía", }, 'error' : true }
Consultar documentos pendientes por cobrar
Es posible tener un listado separado por comas [[1]]