Object PAR Response Parameters

The response body is a JSON object containing the PAR URL or an error message if an exception occurs.

(Required) <Enter introductory text here, including the definition and purpose of the concept.>

Successful Response JSON Sample

If successful, the response JSON object will have the following structure:

Sample Response 1:

{
"PAR_URL": http://example.com/par/12345    
"STATUS":    "SUCCESS",    
"MESSAGE": "PAR Generated Successfully "
}
}

Failed Response JSON Sample

This FAILED response is given in case of high volume data:

Failed Sample Response 2:

{
    "preAuthenticatedURL": "",
    " status":    "failed",
    "message": "Response contains multiple PAR urls due to high volume data. Please
      provide batchID to fetch the full list."
}

If you have received Response 2, you must also provide the batchID in the Query Parameters to fetch PAR url list:

Table 3-2 Query Parameters

Parameter	Value Type	Description
filename*	String	The name of the file for which to retrieve the PAR URL.
date*	String	The date associated with the PAR URL.
batchID	String	Optional, use only if available.

Rerun the query after updating the parameters to provide the batchID. If successful, you will receive the following response:

Successful Sample Response 2:

{
        "preAuthenticatedURL": ["http://example.com/par/1111.csv",
     "http://example.com/par/2222.csv",
     "http://example.com/par/12345.csv"],
        "status":    "Success",
        "message": "PAR Generated Successfully "
}

If an exception occurs, the response JSON object will have the following structure:

Exception Response:

{
    "STATUS": "FAILED",
    "MESSAGE": "Unable to Fetch PAR due to Exception:
    [error_message]"
}