GET v1/results/confirmdownload?batchids={batchids}&failedResultIDs={failedResultIDs}

Confirm Result Download: Confirm the download of results

Request Information

URI Parameters

NameDescriptionTypeAdditional information
batchids

Comma separated list of batchIDs returned in the response of the result download.

string

Required

failedResultIDs

Comma separated list of Result IDs that failed to process and thus should not be marked as download confirmed. Leave empty if all results in the batch downloaded successfully.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

BaseResponse
NameDescriptionTypeAdditional information
Error

Will be set to True if any errors occur during the processing of the API method.

boolean

None.

ErrorMessage

Will contain an error message string if Error is True.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<BaseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 2</ErrorMessage>
</BaseResponse>