Report operation

Introduction

Once you have created the "Case file", an "Evidence Group" within this "Case file" and some "Evidences" within this "Evidence Group", you can generate a report.

Operations

Generate report preview

HTTP Request

POST /api/v1/private/case-files/{caseFileId}/report-preview

In this request, there is one primary resource case-files. There are also 1 resource identifier that you need to replace with real values of your Legal App platform account: caseFileId.

With the following information provided as JSON:

{
        "template": "string",
        "languageCode": "string",
        "data": {
          "groups": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "code": "example code",
              "name": "example name",
              "description": "example name",
              "type": "FILE",
              "capturedFrom": "2023-10-25T05:48:54.530Z",
              "capturedUntil": "2023-10-25T05:48:54.530Z",
              "evidences": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "title": "example title"
                }
              ]
            }
          ]
        },
        "additionalData": {
          "additionalProp1": {}
        }
      }

Request body parameters

Parameter Mandatory Datatype Description
template yes string The name of the template. We have currently some templates, for examples: "Certificate_ngroups" and "Certificate_1certius"
languageCode yes string The language of the report. We have currently two languages: "es_ES" and "en_EN"
data yes string The data of the report. Example: 
 "data": {
            "groups": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "code": "example code",
                "name": "example name",
                "description": "example name",
                "type": "FILE",
                "capturedFrom": "2023-10-25T05:48:54.530Z",
                "capturedUntil": "2023-10-25T05:48:54.530Z",
                "evidences": [
                  {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "title": "example title"
                  }
                ]
              }
            ]
          },
. All the "Evidence groups" must be sent and within these "Evidence groups" the "Evidence" that we want to incorporate into the report.

As response, you will get an HTML with the preview of the Report.

Generate signed report

HTTP Request

POST /api/v1/private/case-files/{caseFileId}/reports

In this request, there is one primary resource case-files. There are also 1 resource identifier that you need to replace with real values of your Legal App platform account: caseFileId.

With the following information provided as JSON:

{
        "reportId": "4ga85f64-5717-4562-b3fc-2c963f66afb7",
        "template": "string",
        "languageCode": "string",
        "data": {
          "groups": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "code": "example code",
              "name": "example name",
              "description": "example name",
              "type": "FILE",
              "capturedFrom": "2023-10-25T05:48:54.530Z",
              "capturedUntil": "2023-10-25T05:48:54.530Z",
              "evidences": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "title": "example title"
                }
              ]
            }
          ]
        },
        "additionalData": {
          "additionalProp1": {}
        }
      }

Request body parameters

Parameter Mandatory Datatype Description
template yes string The name of the template. We have currently some templates, for examples: "Certificate_ngroups" and "Certificate_1certius"
languageCode yes string The language of the report. We have currently two languages: "es_ES" and "en_EN"
data yes string The data of the report. Example: 
 "data": {
            "groups": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "code": "example code",
                "name": "example name",
                "description": "example name",
                "type": "FILE",
                "capturedFrom": "2023-10-25T05:48:54.530Z",
                "capturedUntil": "2023-10-25T05:48:54.530Z",
                "evidences": [
                  {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "title": "example title"
                  }
                ]
              }
            ]
          },
. All the "Evidence groups" must be sent and within these "Evidence groups" the "Evidence" that we want to incorporate into the report.

As response, you will get 

201 Generated signed report

Get Report PDF URL

HTTP Request

GET /api/v1/private/case-files/{caseFileId}/reports/{reportId}/document

In this request, there is one primary resource case-files. There are also 2 resource identifiers that you need to replace with real values of your Legal App platform account: caseFileId and reportId.

As response, you will get the temporary download URL.

Get Report ZIP URL

HTTP Request

GET /api/v1/private/case-files/{caseFileId}/reports/{reportId}/package

In this request, there is one primary resource case-files. There are also 2 resource identifiers that you need to replace with real values of your Legal App platform account: caseFileId and reportId.

As response, you will get the temporary download URL.