Ejemplo obtención documentos por estado

Ejemplo de obtención de documentos por estado

A continuación se detallarán los datos necesarios para realizar la integración que permita obtener el listado de documentos en un estado concreto. Podemos obtener los documentos asociados a un usuario existente, o bien los documentos visibles a todos los usuarios pertenecientes a un determinado grupo.

Documentos asignados a un usuario

Para obtener un listado de los documentos en un determinado estado y asignados a un usuario existente tendremos que realizar la siguiente petición:

URL de la Solicitud:

La URL de la solicitud será:

https://sandbox.viafirma.com/documents/api/v3/messages/{status}/user/{userCode}

Además, indicaremos que la petición HTTP es de tipo GET.

Parámetros:

Los parámetros requeridos son:

status: estado en el que se encuentran los documentos (ejemplo: WAITING).
userCode: código del usuario al que están asignados los documentos (ejemplo: user1234).

Respuesta:

Los datos obtenidos consistirán en:

el cuerpo de la Respuesta, que contendrá el listado con los documentos obtenidos:

[
    {
        "messageCode": "1493028491652R956",
        "status": "WAITING",
        "userCode" : "user1234",
        "groupCode" : "groupA",
        "templateCode": "template_example",
        "creationDate": 1495176157551
    },
    {
        "messageCode": "1472093891409R34",
        "status": "WAITING",
        "userCode" : "user1234",
        "templateCode": "template_example",
        "creationDate": 1495176157802
    },
    {
        "messageCode": "147739024511R993",
        "status": "WAITING",
        "userCode" : "user1234",
        "groupCode" : "groupB",
        "templateCode": "template_example",
        "creationDate": 1495176157223
    }
]

el código HTTP del estado de la operación:

Documentos asignados a un grupo

Para obtener un listado de los documentos en un determinado estado y asignados a un grupo existente tendremos que realizar la siguiente petición: