<back to all web services
DownloadReport
Get the specified report as a download
Requires Authentication
| Requires any of the roles: | SystemAdministrator, Manager, Customer |
The following routes are available for this service:| GET | /reports/{reportId}.xlsx | | |
|---|
DownloadReport Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ReportId | path | string | No | |
HttpResult Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ResponseText | form | string | No | |
| ResponseStream | form | Stream | No | |
| FileInfo | form | FileInfo | No | |
| VirtualFile | form | IVirtualFile | No | |
| ContentType | form | string | No | |
| Headers | form | Dictionary<string, string> | No | |
| Cookies | form | List<Cookie> | No | |
| ETag | form | string | No | |
| Age | form | TimeSpan? | No | |
| MaxAge | form | TimeSpan? | No | |
| Expires | form | DateTime? | No | |
| LastModified | form | DateTime? | No | |
| CacheControl | form | CacheControl | No | |
| ResultScope | form | Func<IDisposable> | No | |
| AllowsPartialResponse | form | bool | No | |
| Options | form | IDictionary<string, string> | No | |
| Status | form | int | No | |
| StatusCode | form | HttpStatusCode | No | |
| StatusDescription | form | string | No | |
| Response | form | Object | No | |
| ResponseFilter | form | IContentTypeWriter | No | |
| RequestContext | form | IRequest | No | |
| View | form | string | No | |
| Template | form | string | No | |
| PaddingLength | form | int | No | |
| IsPartialRequest | form | bool | No | |
IVirtualFile Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| VirtualPathProvider | form | IVirtualPathProvider | No | |
| Extension | form | string | No | |
| Length | form | long | No | |
IVirtualPathProvider Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| RootDirectory | form | IVirtualDirectory | No | |
| VirtualPathSeparator | form | string | No | |
| RealPathSeparator | form | string | No | |
CacheControl Enum:| Name | Value | |
|---|
| None | 0 | |
| Public | 1 | |
| Private | 2 | |
| MustRevalidate | 4 | |
| NoCache | 8 | |
| NoStore | 16 | |
| NoTransform | 32 | |
| ProxyRevalidate | 64 | |
IRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| OriginalRequest | form | Object | No | |
| Response | form | IResponse | No | |
| OperationName | form | string | No | |
| Verb | form | string | No | |
| RequestAttributes | form | RequestAttributes | No | |
| RequestPreferences | form | IRequestPreferences | No | |
| Dto | form | Object | No | |
| ContentType | form | string | No | |
| IsLocal | form | bool | No | |
| UserAgent | form | string | No | |
| Cookies | form | IDictionary<string, Cookie> | No | |
| ResponseContentType | form | string | No | |
| HasExplicitResponseContentType | form | bool | No | |
| Items | form | Dictionary<string, Object> | No | |
| Headers | form | NameValueCollection | No | |
| QueryString | form | NameValueCollection | No | |
| FormData | form | NameValueCollection | No | |
| UseBufferedStream | form | bool | No | |
| RawUrl | form | string | No | |
| AbsoluteUri | form | string | No | |
| UserHostAddress | form | string | No | |
| RemoteIp | form | string | No | |
| Authorization | form | string | No | |
| IsSecureConnection | form | bool | No | |
| AcceptTypes | form | string[] | No | |
| PathInfo | form | string | No | |
| OriginalPathInfo | form | string | No | |
| InputStream | form | Stream | No | |
| ContentLength | form | long | No | |
| Files | form | IHttpFile[] | No | |
| UrlReferrer | form | Uri | No | |
IResponse Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| OriginalResponse | form | Object | No | |
| Request | form | IRequest | No | |
| StatusCode | form | int | No | |
| StatusDescription | form | string | No | |
| ContentType | form | string | No | |
| OutputStream | form | Stream | No | |
| Dto | form | Object | No | |
| UseBufferedStream | form | bool | No | |
| IsClosed | form | bool | No | |
| KeepAlive | form | bool | No | |
| HasStarted | form | bool | No | |
| Items | form | Dictionary<string, Object> | No | |
RequestAttributes Enum:| Name | Value | |
|---|
| None | 0 | |
| Localhost | 1 | |
| LocalSubnet | 2 | |
| External | 4 | |
| Secure | 8 | |
| InSecure | 16 | |
| AnySecurityMode | 24 | |
| HttpHead | 32 | |
| HttpGet | 64 | |
| HttpPost | 128 | |
| HttpPut | 256 | |
| HttpDelete | 512 | |
| HttpPatch | 1024 | |
| HttpOptions | 2048 | |
| HttpOther | 4096 | |
| AnyHttpMethod | 8160 | |
| OneWay | 8192 | |
| Reply | 16384 | |
| AnyCallStyle | 24576 | |
| Soap11 | 32768 | |
| Soap12 | 65536 | |
| Xml | 131072 | |
| Json | 262144 | |
| Jsv | 524288 | |
| ProtoBuf | 1048576 | |
| Csv | 2097152 | |
| Html | 4194304 | |
| Jsonl | 8388608 | |
| MsgPack | 16777216 | |
| FormatOther | 33554432 | |
| AnyFormat | 67076096 | |
| Http | 67108864 | |
| MessageQueue | 134217728 | |
| Tcp | 268435456 | |
| Grpc | 536870912 | |
| EndpointOther | 1073741824 | |
| AnyEndpoint | 2080374784 | |
| InProcess | -2147483648 | |
| InternalNetworkAccess | -2147483645 | |
| AnyNetworkAccessType | -2147483641 | |
| Any | -1 | |
IRequestPreferences Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| AcceptsBrotli | form | bool | No | |
| AcceptsDeflate | form | bool | No | |
| AcceptsGzip | form | bool | No | |
IHttpFile Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Name | form | string | No | |
| FileName | form | string | No | |
| ContentLength | form | long | No | |
| ContentType | form | string | No | |
| InputStream | form | Stream | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /reports/{reportId}.xlsx HTTP/1.1
Host: evovoice.io
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}