| POST | /v1/reports | Retrieve Report by ReportName and Filters |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportName | body | string | Yes | Report Name |
| Filters | body | Dictionary<string, ReportFilter> | Yes | Filters |
| Paging | body | ReportsPaging | Yes | Paging |
| Sorting | body | Dictionary<string, ReportSortType> | Yes | Sorting |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | ReportFilterType | No | |
| Values | form | IEnumerable<string> | Yes | |
| Start | form | DateTime? | No | |
| End | form | DateTime? | No | |
| HigherThan | form | int? | No | |
| LowerThan | form | int? | No |
| list | |
| list_like | |
| date | |
| range |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | form | int | No | |
| PageSize | form | int | No |
| asc | |
| desc |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalCount | form | int | No | |
| ReportResult | form | IEnumerable<Object> | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/reports HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reportName: String,
filters:
{
String:
{
type: list,
start: 0001-01-01,
end: 0001-01-01,
higherThan: 0,
lowerThan: 0
}
},
paging:
{
page: 0,
pageSize: 0
},
sorting:
{
String: asc
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
totalCount: 0
}