file-transmission-synchronous

Backend microservice providing an API to transfer a single or multiple files from some network location (usually the Upscan bucket) to the PEGA/Documentum via an EIS API endpoint /cpr/filetransfer/caseevidence/v1.

Currently service supports two kinds of download URLs:

http(s)
data: RFC 2397

API

Transfer Single File

Requests file transfer from some downloadUrl returned by Upscan callback to /cpr/filetransfer/caseevidence/v1.

Method	Path	Description	Authorization
`POST`	`/transfer-file`	transfer file to the PEGA/Documentum system via EIS	any GovernmentGateway authorized user

Header	Description
`x-correlation-id`	message correlation UUID (optional)
`x-request-id`	request UUID (optional)

Response status	Description
202	when file transfer successful
400	when payload malformed or has not passed the validation

Example request payload:

{
    "conversationId": "074c3823-c941-417e-a08b-e47b08e9a9b7",
    "caseReferenceNumber": "Risk-123",
    "applicationName": "Route1",
    "upscanReference": "XYZ0123456789",
    "downloadUrl": "https://s3.amazonaws.com/bucket/9d9e1444-2555-422e-b251-44fd2e85530a",
    "fileName": "test.jpeg",
    "fileMimeType": "image/jpeg",
    "fileSize": 12345,  // optional
    "checksum": "a38d7dd155b1ec9703e5f19f839922ad5a1b0aa4f255c6c2b03e61535997d757",
    "batchSize": 1,
    "batchCount": 1
}

Example 400 error response payload

{
    "correlationId" : "7fedc2d5-1bba-434b-87e6-4d4ec1757e31",
    "error" : {
        "errorCode" : "400",
        "errorMessage" : "invalid case reference number"
    }
}

Transfer Multiple Files

Method	Path	Description	Authorization
`POST`	`/transfer-multiple-files`	transfer multiple files to the PEGA/Documentum system via EIS	any GovernmentGateway authorized user

Header	Description
`x-request-id`	request UUID (optional)

Response status	Description
201	when no callback URL provided and all files transfers has been completed (with successes or failures)
202	when callback URL is defined and all files transfers has been completed (with successes or failures)
400	when payload malformed or has not passed the validation

Example request payload:

{
    "conversationId": "074c3823-c941-417e-a08b-e47b08e9a9b7",
    "caseReferenceNumber": "Risk-123",
    "applicationName": "Route1",
    "files": [
        {
            "upscanReference": "XYZ0123456789",
            "downloadUrl": "https://s3.amazonaws.com/bucket/9d9e1444-2555-422e-b251-44fd2e85530a",
            "fileName": "test1.jpeg",
            "fileMimeType": "image/jpeg",
            "fileSize": 12345,  // optional
            "checksum": "a38d7dd155b1ec9703e5f19f839922ad5a1b0aa4f255c6c2b03e61535997d75"
        },
        ...
    ],
    "callbackUrl":"https://foo.protected.mdtp/transfer-multiple-files/callback/NONCE"  //optional,
    "metadata": //anything JSON
}

Example 201 response payload (when no callback URL) or callback payload (when callback URL):

{
    "conversationId": "074c3823-c941-417e-a08b-e47b08e9a9b7",
    "caseReferenceNumber": "Risk-123",
    "applicationName": "Route1",
    "results":[
        {
            "upscanReference":"XYZ0123456789",
            "fileName": "test1.jpeg",
            "fileMimeType": "image/jpeg",
            "checksum":     "a38d7dd155b1ec9703e5f19f839922ad5a1b0aa4f255c6c2b03e61535997d75",
            "fileSize":1210290,
            "success":true,
            "httpStatus":202,
            "transferredAt":"2021-07-11T12:53:46",
            "correlationId":"07b8090f-69c8-4708-bfc4-bf1731d4b4a8",
            "durationMillis": 1587
        },
        {
            "upscanReference":"XYZ0123456789",
            "fileName": "test2.jpeg",
            "fileMimeType": "image/jpeg",
            "checksum":     "a38d7dd155b1ec9703e5f19f839922ad5a1b0aa4f255c6c2b03e61535997d75",
            "fileSize":98989,
            "success":false,
            "httpStatus":500,
            "transferredAt":"2021-07-11T12:54:01",
            "correlationId":"ef240b91-88a2-45c4-961a-17ca34a6ea3a",
            "durationMillis": 18590,
            "error":"some error description"
        },
        ...
    ],
    "totalDurationMillis": 23018,
    "metadata": //original request's metadata
}

Example 400 error response payload:

{
    "correlationId" : "7fedc2d5-1bba-434b-87e6-4d4ec1757e31",
    "error" : {
        "errorCode" : "400",
        "errorMessage" : "invalid case reference number"
    }
}

Running the tests

sbt test it:test

Running the tests with coverage

sbt clean coverageOn test it:test coverageReport

Running the app locally

sm --start FILE_TRANSMISSION_SYNCHRONOUS
sm --start TRADER_SERVICES_ROUTE_ONE_STUB
sbt run

It should then be listening on port 10003

License

This code is open source software licensed under the Apache 2.0 License

arturopala/file-transmission-synchronous