GET api/UserReports/{id}

Retrieves the definition of the specified custom report.

Request

Parameters

Name Description Default
id Unique report ID.

Response

Body

Content Type: application/xml
Schema: http://download.overtech.com.au/schemas/LedgerView.xsd
XML document or an error message.

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid report ID.
401 Unauthorized Access token is invalid, expired or not specified.
404 Not FoundReport not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

Report definitions are used by ContactsLaw to build filters, query data and format the output. To execute a report non-interactively, only the names of the parameters and columns are relevant.