GET api/GetJobImage?AuthToken={AuthToken}&JobID={JobID}&FileName={FileName}&ImageOption={ImageOption}
Get single Image
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AuthToken |
Users AuthToken provided from Authenticate method |
string |
Required |
| JobID |
Job ID for image |
integer |
Required |
| FileName |
File Name of the image (fully qualified file name including extension) |
string |
Required |
| ImageOption |
Image Option to control what image data is returned, FullSize, Thumb will return images as thumb nails (approx 15kb) , 1/2, 1/4, 1/8 or Size (100 for 100kb) to return scaled images, Default is Thumb |
string |
Default value is Thumb |
Body Parameters
None.
Response Information
Resource Description
ImageItem Record
ImageItem| Name | Description | Type | Additional information |
|---|---|---|---|
| FileName |
The Image FileName |
string |
None. |
| ImageType |
The Image Type (Damage, Primary , Addtional) |
string |
None. |
| MimeType |
The Mime Type (jpg) |
string |
None. |
| FileSize |
The Image Size |
integer |
None. |
| ImageData |
The Image Data |
Collection of byte |
None. |
Response Formats
application/json, text/json
Sample:
{
"FileName": "sample string 1",
"ImageType": "sample string 2",
"MimeType": "sample string 3",
"FileSize": 4,
"ImageData": "QEA="
}
application/xml, text/xml
Sample:
<ImageItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JAMAPI.Models"> <FileName>sample string 1</FileName> <FileSize>4</FileSize> <ImageData>QEA=</ImageData> <ImageType>sample string 2</ImageType> <MimeType>sample string 3</MimeType> </ImageItem>