Estado y resumen de un SET

Última revisión: 07 SEPT 2023

Tienes dos métodos disponible en el API para conocer el estado de un SET:

• GET /set/status
• GET /set/summary

Con el que obtendrás el estado con la mínima información necesaria y un resumen del SET respectivamente, tal y como te describimos a continuación.

GET /set/status/{setCode}

Este servicio te devuelve el estado de un SET y de todos sus firmantes, con la información mínima necesaria para tu lógica de negocio.

• Método: GET
• Servicio: urlbase/api/v3/set/status/{setCode}
• Content Type: URL param
• Params de entrada: setCode

{setCode} : (string) (obligatorio) código del SET devuelto por Viafirma.

• Response Content Type: application/type JSON en el Body de la response.
• Response Status: 200 OK
• Response Body:

{
    "code": "string",
    "status": "string",
    "recipientStatus": [
        {
            "key": "string",
            "messageCode": "string",
            "status": "string"
        }
    ]
}

Ejemplo:

{
    "code": "LL621679493874544T350",
    "status": "RECEIVED",
    "recipientStatus": [
        {
            "key": "firmante1",
            "messageCode": "LL621679493874551R655",
            "status": "PENDING"
        }
    ]
}

• Response Status: Distinto de 200 NO OK
• Response Body:

{
    "code": 9,
    "type": "String",
    "message": "string",
    "trace": "string"
}

Ejemplo:

Response Status: 500 Internal Server Error

{
    "code": 265,
    "type": "Error",
    "message": "It is not possible to recover the requested set information",
    "trace": "99afed75-979d-4b86-a55f-9022d7ee11d3"
}

GET /set/summary/{setCode}

Este servicio te devuelve el resumen de un SET, incluyendo el resumen de todos sus firmantes, políticas y documentos.

• Método: GET
• Servicio: urlbase/api/v3/set/summary/{setCode}
• Content Type: URL param
• Params de entrada: setCode

{setCode} : (string) (obligatorio) código del SET devuelto por Viafirma.

• Response Content Type: application/type JSON en el Body de la response.
• Response Status: 200 OK
• Response Body:

{
    "code": "string",
    "status": "string",
    "links": [ ],
    "groupCode": "string",
    "creationDate": 0,
    "updateDate": 0,
    "userName": "string",
    "groupTitle": "string",
    "messages": [ ]
}

Ejemplo:

{
    {
    "code": "LL621694067681443T337",
    "title": "2.pdf",
    "description": "",
    "status": "RESPONSED",
    "links": [
        {
            "key": "73136e15-fcba-40db-98a4-a0301a63c4a4",
            "messageCode": "LL621694067681448R289",
            "status": "RECEIVED",
            "mail": "[email protected]",
            "name": "Administrador",
            "userCode": "admin"
        }
    ],
    "groupCode": "DEMO_viafirma",
    "creationDate": 1694067682164,
    "updateDate": 1694067857216,
    "expirationDate": 1694931659561,
    "userName": "Administrador",
    "groupTitle": "DEMO viafirma",
    "messages": [
        {
            "code": "LL621694067681448R289",
            "status": "RESPONSED",
            "templateCode": "",
            "policies": [
                {
                    "evidences": [
                        {
                            "type": "SIGNATURE",
                            "id": "1694074318820",
                            "enabled": true,
                            "visible": true,
                            "code": "LL621694067681448R289P001E001",
                            "status": "ADDED",
                            "helpText": "Firma manuscrita de Administrador",
                            "positions": [
                                {
                                    "rectangle": {
                                        "x": 177,
                                        "y": 726,
                                        "width": 125,
                                        "height": 62
                                    },
                                    "page": 1
                                }
                            ],
                            "recipientKey": "73136e15-fcba-40db-98a4-a0301a63c4a4",
                            "imageTextSize": 30
                        }
                    ],
                    "signatures": [
                        {
                            "type": "SERVER",
                            "code": "LL621694067681448R289P001S001",
                            "status": "SIGNED",
                            "helpText": "Sello del documento",
                            "lastUpdated": 0
                        }
                    ]
                }
            ],
            "transfers": [],
            "languageId": "",
            "externalCode": "",
            "commentReject": "",
            "title": "2.pdf",
            "description": "2.pdf"
        }
    ]
}

• Response Status: Distinto de 200 NO OK
• Response Body:

{
    "code": 9,
    "type": "String",
    "message": "string",
    "trace": "string"
}

Ejemplo:

Response Status: 500 Internal Server Error

{
    "code": 265,
    "type": "Error",
    "message": "It is not possible to recover the requested set information",
    "trace": "99afed75-979d-4b86-a55f-9022d7ee11d3"
}