User Tools


Webservice Method Reference

Retrieve Attachment

Purpose:Retrieve file attached to a document as a base64 encoded string. This method was added instead of modifying the already existing Retrieve method to avoid having to download all attachments when only a list is required and so we wouldn't have to modify the existing interface of the retrieve method.
Profile:retrievedocattachment(id:Id,returnfile:boolean):Map
Send as:POST
Parameters:
 id: comma separated list of document identifiers to obtain
 returnfile: true if we need to really get the file, false to just get the information of the attachment
Response:A map object with all the information of the attachment
URL Format:
http://corebos_url/webservice.php?operation=retrievedocattachment&sessionName=[session id]&id=[id documento]&returnfile=[0|1]
Examples:REST Document Manipulation Enhancements

Revise

The main difference between vtws_revise and vtws_update is that for revise you can send only those fields that needs to be changed, but for update api you need to send all the mandatory fields to update a record. If you send unknown fields then it will silently ignore them, the reason for this behavior is that the user may not have permission for few fields and the system may not know if these fields are not available in the system or the user does not have permission for these fields.

CRUD

Users

El API actual soporta la manipulación de usuarios como si fuera cualquier otra entidad, o sea, puedes utilizar Create, Update y Retrieve como con cualquier otra entidad. La restricción es que por fuerza ha de ser un usuario administrador el que ejecute las llamadas al igual que ocurre dentro de la aplicación.

Para poder eliminar un usuario hay que utilizar el método DeleteUser porque, al igual que dentro de la aplicación y a diferencia del Delete normal, es necesario dar el usuario destinatario de los registros asignado al usuario que vamos a eliminar.

Finalmente una nota. Lorenzo me ha informado por encima del proyecto del portal. Lo correcto es crear Contactos para el acceso de tus clientes al portal, no usuarios. Por si es para eso que necesitas la información anterior.

https://github.com/tsolucio/coreBOSwsDevelopment/blob/master/testcode/028lib_createUser.php

https://github.com/tsolucio/coreBOSwsDevelopment/blob/master/testcode/060lib_updateUser.php

https://github.com/tsolucio/coreBOSwsDevelopment/blob/master/testcode/070lib_deleteUser.php


coreBOS Documentación