Retrieve page of mediation files loaded into Elevate

get/mediation-files

The call is restricted to a max of one month's worth of data and/or the first 100 entries retrieved. Use proper pagination to obtain the required data

SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
fileName
string

Filter by fileName

fileType
string

Filter by fileType

supplierId
integer

Filter by supplierId

status
string (MediationFileStatus)

Filter by status (ERROR, SUCCESS, PENDING)

Enum: "NEW" "TO_BE_PROCESSED" "DELETED" "BEING_PROCESSED" "ERROR" "PENDING_DELETE" "PENDING_REPROCESS" "PROCESSING_DECOMPRESS" "SUCCESS" "DUPLICATE" "PARTIAL_SUCCESS" "REPROCESSED" "ARCHIVED" "IGNORED"
dateLoaded
string (DateTimeFilterParam)

Filter by dateLoaded

Example: dateLoaded=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
dateDetectedFrom
required
string (DateTimeFilterParam)

Filter by dateDetected from date/time (inclusive)

Example: dateDetectedFrom=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
dateDetectedTo
required
string (DateTimeFilterParam)

Filter by dateDetected to date/time (exclusive)

Example: dateDetectedTo=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "fileName": "ABCD_9640856_ABCDEF_010821_000000.DAT",
    • "compressedFileName": "ABCD_9640856_ABCDEF_010821_000000.DAT.pgp",
    • "fileType": "SupplierA SSBS",
    • "supplierId": 1,
    • "status": "NEW",
    • "dateDetected": "2019-08-24T14:15:22Z",
    • "dateLoaded": "2019-08-24T14:15:22Z",
    • "totalRecords": 1000,
    • "ignoredRecords": 3
    }
]