Response [200 Ok]
| Uri | /api/v2/image/PWMVFQx-2!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
LargestImage [1 of 1]
/api/v2/image/PWMVFQx-2!largestimage
| Uri | /api/v2/image/PWMVFQx-2!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| Ext | jpg |
| Height | 2832 |
| Size | 5561512 |
| Url | https://photos.smugmug.com/Lopez-Island/Lopez-Island-all-Images/i-PWMVFQx/2/KxKSGFT8vWVHTwz8GFxV2sTWQn8gdmTVWTQvPBLs7/O/_D3S3222.jpg |
| Usable | true |
| Watermarked | false |
| Width | 4256 |
Uris
ImageSizeOriginal
/api/v2/image/PWMVFQx-2!sizeoriginal
| Uri | /api/v2/image/PWMVFQx-2!sizeoriginal |
|---|---|
| UriDescription | Image size: original |
| EndpointType | ImageSizeOriginal |
| Locator | ImageSizeOriginal |
| LocatorType | Object |
Request
| Uri | /api/v2/image/PWMVFQx-2!largestimage |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- The Uris.Locator will vary depending on the maximum available size
- If this image is generated on-the-fly, Size is not available in the response data
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
Output Fields
| Ext | text | |
|---|---|---|
| Height | integer | |
| MD5 | text | |
| Size | integer | |
| Url | uri | |
| Usable | boolean | |
| Watermarked | boolean | |
| Width | integer |
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/image/PWMVFQx-2!largestimage"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
}
},
"Methods": [
"OPTIONS",
"GET"
],
"ParameterDescription": {
"Select": "Select one option. Options should pass only the \"Value\"."
},
"Parameters": {
"GET": [
{
"Name": "MaxSize",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Select",
"OPTIONS": [
"ImageSizeTiny",
"ImageSizeThumb",
"ImageSizeSmall",
"ImageSizeMedium",
"ImageSizeLarge",
"ImageSizeXLarge",
"ImageSizeX2Large",
"ImageSizeX3Large",
"ImageSizeX4Large",
"ImageSizeX5Large",
"ImageSize4K",
"ImageSize5K",
"ImageSizeOriginal"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
}
]
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "Url",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": []
},
{
"Name": "Size",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "Height",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "Width",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "MD5",
"Type": "Text",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Usable",
"Type": "Boolean"
},
{
"Name": "Ext",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Watermarked",
"Type": "Boolean"
}
],
"Notes": [
"The Uris.Locator will vary depending on the maximum available size",
"If this image is generated on-the-fly, Size is not available in the response data"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "image"
},
{
"type": "singleparam",
"param_name": "imagekey",
"param_value": "PWMVFQx-2",
"param_validator": {}
},
{
"type": "action",
"text": "largestimage"
}
]
},
"Response": {
"Uri": "/api/v2/image/PWMVFQx-2!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"LargestImage": {
"Url": "https://photos.smugmug.com/Lopez-Island/Lopez-Island-all-Images/i-PWMVFQx/2/KxKSGFT8vWVHTwz8GFxV2sTWQn8gdmTVWTQvPBLs7/O/_D3S3222.jpg",
"Size": 5561512,
"Height": 2832,
"Width": 4256,
"Usable": true,
"Ext": "jpg",
"Watermarked": false,
"Uri": "/api/v2/image/PWMVFQx-2!largestimage",
"UriDescription": "Largest size available for image",
"Uris": {
"ImageSizeOriginal": {
"Uri": "/api/v2/image/PWMVFQx-2!sizeoriginal",
"Locator": "ImageSizeOriginal",
"LocatorType": "Object",
"UriDescription": "Image size: original",
"EndpointType": "ImageSizeOriginal"
}
}
},
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage",
"Timing": {
"Total": {
"time": 0.10897,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}