<back to all web services
GetImage
The following routes are available for this service:| GET | /image | Returns the specified image based on the Id. | |
|---|
| GET | /image/{id} | Returns the specified image based on the Id. | |
|---|
GetImage Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Id | path | int | Yes | |
| ImageSize | query | ImageSize | No | Manually control the server resizing of the image.Allowable Values- Unknown
- Full
- Small
- Medium
- Large
- XLarge
|
| Base64 | query | boolean | No | Set to true to return the image in Base64 format. |
| Platform | query | string | Yes | |
| Thumbnail | query | bool | No | Force this file to be returned as a thumbnail (small) |
ImageSize Enum:| Name | Value | |
|---|
| Unknown | 0 | |
| Full | 1 | |
| Small | 2 | |
| Medium | 3 | |
| Large | 4 | |
| XLarge | 5 | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /image HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: application/xml