viafirma inbox :: manual de integración

Obtener datos de una petición

Método para la obtener los datos de una petición a partir de su código público.

  • Tipo: GET
  • URL: url-inbox/api/v3/requests/{publicAccessId}
  • Tipo de salida: application/json
  • Parámetros:
    • publicAccessId: código público de la petición.

Json de salida

El json de salida está compuesto por los siguientes campos:

  • sender: Remitente de la petición, con los siguientes datos:
    • userCode: Código de usuario.
    • entityCode: Código de la entidad del remitente.
  • addresseeLines: Líneas de los destinatarios de la petición. Cada línea de destinatarios está compuesto por una lista de grupos de destinatarios (addresseeGroups). Cada uno de estos grupos tiene los siguientes campos:
    • isOrGroup: true si sólo uno de los usuarios del grupo tiene que realizar la acción.
    • userEntities: Lista de usuarios que componen el grupo.Los datos que se indican son:
      • userCode: Código de usuario.
      • entityCode: Código de la entidad.
      • status: Estado. Posibles valores:
        • NEW: El usuario no ha realziado ninguna acción.
        • READ: El usuario ha leido la acción.
        • SIGNED: El usuario ha firmado la petición.
        • APPROVAL: El usuario ha dado visto bueno a la petición.
        • REJECT: El usuario ha rechazado la petición.
        • NO_ACTION: El usuario no tiene que realizar ninguna acción dado que se encuentra dentro de un grupo de tipo OR donde otro usuario ya ha realizado la acción.
      • action: Acción que realiza el usuario. Posibles valores:
        • SIGN: Firma.
        • APPROVAL: Visto bueno.
      • actionInfo: Información de la acción realizada por el usuario. Se muestran los siguientes datos:
        • userCode: Código del usuario que ha realizado la acción. En acciones realizadas por usuario con delegación no coincidirá con el cdigo del remitente.
        • date: Fecha en la que se realizó la acción.
        • rejectType: Tipo de rechazo
        • rejectReason: Motivo de rechazo
  • internalNotification: Listado de usuarios que formarán parte de la comunicación interna asociada a la petición. Se indicará el código de usuario de cada uno de estos usuarios.
  • subject: Asunto de la petición.
  • message: Mensaje de la petición.
  • publicAccessId: Código público de la petición.
  • *reference: Referencia
  • creationDate: Fecha de creación de la petición.
  • initDate: Fecha de inicio de la petición.
  • expirationDate: Fecha de caducidad de la petición.
  • sendDate: Fecha de envío de la petición.
  • verificationAccess: Tipo de acceso a la verificación de la petición. Se deben muestran los siguientes campos:
    • type: Tipo de acceso. Por defecto ANONYMOUS. Los posibles valores son:
      • NOTAVAILABLE: La petición no está accesible desde el apartado de verificación.
      • ANONYMOUS: Cualquier usuario tiene acceso a la petición.
      • USERPASSWORD: Acceso mediante usuario y contraseña.
      • CERTIFICATE: Requiere autenticación con certificado. Y debe tratarse de uno de los usuarios que forman parte de la petición. Es decir que sea el remitente o uno de los destinatarios.
      • PRIVATE: Tan sólo el remitente tiene acceso a la verificación.
    • username: Usuario para el acceso a la petición para el tipo USERPASSWORD.
    • password: Contraseña para el acceso a la petición para el tipo USERPASSWORD.
  • senderNotificationLevel: Nivel de notificaciones para el remitente de la petición. Los valores permitidos son:
    • NO: El remitente no recibe notificaciones para esta petición.
    • ALL: El remitente recie notificaciones cada vez que un destinatario lee, firma, da visto bueno o rechaza. También recibirá una notificación cuando finalice la petición.
    • MEDIUM: El remitente recie notificaciones cada vez que un destinatario firma, da visto bueno o rechaza. También recibirá una notificación cuando finalice la petición.
    • FINISH: EL remitente recibirá una notificación cuando finalice la petición.
  • notificationUrl: Url de notificación cuando se finalice la petición.
  • stampName: Nombre del sello empleado.
  • status: Estado de la petición. Los posibles valores son:
    • NOT_STARTED: Petición no iniciada.
    • IN_PROCESS: Petición en curso.
    • COMPLETED: Petición finalizada.
    • EXPIRED: Petición caducada.
    • REJECTED: Petición rechazada.
  • metadatas: Listado de metadatas de la petición. Para cada metadata se indican:
    • key
    • value
  • documentsToSign: Listado de documentos a firmar. Los datos que se muestran para cada documento son:
    • filename: Nombre del fichero.
    • publicAccessId: Código público del documento.
  • documentsAnnexes: Listado de documentos anexos. Los datos que se muestran para cada documento son:
    • filename: Nombre del fichero.
    • publicAccessId: Código público del documento.
  • rejectInfo: Información relacionada con el rechazo de una petición, en caso de haber sido rechazada.
    • rejectUser: Nombre del usuario que ha rechazado la petición.
    • rejectType: Tipo de rechazo seleccionado.
    • rejectReason: Motivo del rechazo.
    • rejectDate: Fecha de rechazo.

Ejemplo de json de salida