This service retrieves the photo data associated with the photo Id specified in the URL.
Photo support is specific to adding images to Mobile forms, not driver profiles. You can manage driver profile photos from the Fleet platform.
No request body is used for this service.
Because photos include both JSON (metadata) and binary (bitmap) components, you retrieve photo information in a two-step process:
First, request the JSON metadata for the photo by its Id:
Next, download the binary image file by its fullImageUrl:
If the image file associated with the photo has not been uploaded, the GET image request returns a 404 response.
For photos unlikely to change (such as visual records), you can just make use of the URL for the image file without re-downloading the metadata for it.
If you want to replace the image, use the PUT /attachments operation to upload a new file to the same URL.
On success, the response body contains a JSON array of photo objects:
|id||string||The GUID of the photo.|
|name||string||(Telogis key) The name of the image file, which must be unique. If the file extension is not specified, browser clients derive it from the content type.|
|path||string||(optional) User-specified path on the file system for photo files.|
|captureTime||string||The ISO 8601 timestamp for when the photo was taken.|
|captureAddress||Address||The location where the photo was taken.
|fullImageUrl||Uri||(read-only) The URL to the photo image file.|
|sizeInBytes||int?||(read-only) The size of the image file, in bytes.|
|pixelHeight||int?||(read-only) For aspect ratio as x:y, the photo's height (y) in pixels.|
|pixelWidth||int?||(read-only) For aspect ratio as x:y, the photo's width (x) in pixels.|
|contentType||string||(read-only) The MIME Content-Type (file format) that was uploaded. Typical values: 'image/jpeg', 'image/png'.|