Viafirma Documents

Peticiones relacionadas con un grupo

Revisión: 22-octubre-2019

Para conocer las peticiones relacionadas con un grupo podrás consumir el siguiente servicio:

Type Service Format Security
GET /api/v3/messages/{status}/group/{groupCode}/{index}/{page_size}/ application/json OAuth 1.0 / OAuth 2.0 / Basic

Ejemplo GET messages by status and group

GET /v3/messages/{status}/group/{groupCode}/{index}/{page_size}/
  • Donde status corresponde al filtro estado de las peticiones que quiere consultar. Puedes consultar los direfentes estados de una petición aquí.
  • Donde groupCode corresponde al filtro grupo de las peticiones que quiere consultar.
  • Donde index corresponde al índice del listado desde donde quieres que te devuleva el objeto.
  • Donde page_size corresponde número de peticiones que quieres que te devuelva. Si se define como valor 0, se devolverá el listado completo.

Respuesta

Tendrás una respuesta en formato json con el listado de todas la peticiones acorde con el filtro dado, tal y como te explicamos a continuación:

{
    "total": 0,
    "elements": [
        {
        "messageCode": "string",
        "status": "string",
        "userCode": "string",
        "groupCode": "string",
        "templateCode": "string",
        "creationDate": "2018-12-20T09:41:59.992Z"
        }
    ]
}

Donde:

  • total : número de peticiones de firmas que corresponde con los filtros estado y grupo enviados en el GET.
  • messageCode : corresponde al identificador único de la petición de firma.
  • status: corresponde al estado definido en el GET.
  • userCode: usuario que creó la petición de firma.
  • groupCode: grupo al que pertenece la petición y definión en la petición GET.
  • templateCode: plantilla que se utilizó en la petición de firma.
  • creationDate: fecha de creación de la petición de firma.

Errores

Los posibles errores serán devuelto en formato json:

{
    "code": "number",
    "type": "string",
    "message": "string"
}
Code Type Message Desc
81 Error El token utilizado por esta aplicación no es válido. Contacta con el administrador del sistema el consumer-key de las credenciales OAuth NO es correcto
85 Error Tu sesión ha sido cerrada por inactividad. Por favor ingresa nuevamente tus credenciales el consumer-secret de las credenciales OAuth no es correcto o estás usando unas credenciales del tipo USER en lugar del tipo API y en cuyo caso la sesión ha expirado.
91 Error Sorry, this application is not allowed. el API utilizada NO tiene permisos sobre el proceso, bien por que no es el propietario o porque pertenece a un groupCode sobre el que tampoco tiene permisos.

En esta otra guía te enseñamos cómo DESCARGAR el documento firmado