Response [200 Ok]
| Uri | /api/v2/image/M8bZJZN-0 |
|---|---|
| UriDescription | Image by key |
| DocUri | https://api.smugmug.com/api/v2/doc/reference/image.html |
| EndpointType | Image |
| Locator | Image |
| LocatorType | Object |
Image [1 of 1]
/api/v2/image/M8bZJZN-0
| Uri | /api/v2/image/M8bZJZN-0 |
|---|---|
| UriDescription | Image by key |
| Altitude | 0 |
| CanBuy | true |
| CanEdit | false |
| Caption | empty string |
| Collectable | true |
| Date | 2017-01-22T23:23:22+00:00 |
| FileName | Bride4.jpg |
| Format | JPG |
| Hidden | false |
| ImageKey | M8bZJZN |
| IsArchive | false |
| IsVideo | false |
| KeywordArray | |
| Keywords | empty string |
| LastUpdated | 2017-01-22T23:24:02+00:00 |
| Latitude | 0.00000000000000 |
| Longitude | 0.00000000000000 |
| OriginalHeight | 5020 |
| OriginalWidth | 4016 |
| Processing | false |
| Protected | true |
| ThumbnailUrl | https://photos.smugmug.com/Wedding-examples/i-M8bZJZN/0/9f5b7ffc/Th/Bride4-Th.jpg |
| Title | empty string |
| UploadKey | 5660058169 |
| Watermark | No |
| Watermarked | false |
| WebUri | http://www.figmentation.ie/Wedding-examples/i-M8bZJZN |
Formatted Values
Caption [html, text]
| html | empty string |
|---|---|
| text | empty string |
Uris
ImageAlbum
/api/v2/album/jBFqfX
| Uri | /api/v2/album/jBFqfX |
|---|---|
| UriDescription | Album by key |
| EndpointType | Album |
| Locator | Album |
| LocatorType | Object |
ImageComments
/api/v2/image/M8bZJZN!comments
| Uri | /api/v2/image/M8bZJZN!comments |
|---|---|
| UriDescription | Comments on image |
| EndpointType | ImageComments |
| Locator | Comment |
| LocatorType | Objects |
ImageMetadata
/api/v2/image/M8bZJZN!metadata
| Uri | /api/v2/image/M8bZJZN!metadata |
|---|---|
| UriDescription | Metadata for image |
| EndpointType | ImageMetadata |
| Locator | ImageMetadata |
| LocatorType | Object |
ImageOwner
/api/v2/user/simon-martin
| Uri | /api/v2/user/simon-martin |
|---|---|
| UriDescription | User By Nickname |
| EndpointType | User |
| Locator | User |
| LocatorType | Object |
ImagePrices
/api/v2/image/M8bZJZN!prices
| Uri | /api/v2/image/M8bZJZN!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/M8bZJZN-0!sizedetails
| Uri | /api/v2/image/M8bZJZN-0!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/M8bZJZN-0!sizes
| Uri | /api/v2/image/M8bZJZN-0!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/M8bZJZN-0!largestimage
| Uri | /api/v2/image/M8bZJZN-0!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/M8bZJZN!pointofinterest
| Uri | /api/v2/image/M8bZJZN!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/M8bZJZN!poicrops
| Uri | /api/v2/image/M8bZJZN!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/M8bZJZN!regions
| Uri | /api/v2/image/M8bZJZN!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
UnlockAlbumDownload
/api/v2/album/jBFqfX!unlockdownload
| Uri | /api/v2/album/jBFqfX!unlockdownload |
|---|---|
| UriDescription | Unlock password-protected album download |
| EndpointType | UnlockAlbumDownload |
Request
| Uri | /api/v2/image/M8bZJZN-0 |
|---|---|
| Method | GET |
| Version | v2 |
Options
Notes
- The Uri returned by this endpoint may not exist if it was recently uploaded and is being processed
- "Watermark" has been deprecated in favor of "Watermarked". "Watermarked" will only be present for images with a known watermarked state
- Photo sizes, including Original, without a "Size" or "MD5" property, will be generated dynamically upon request
- "ArchivedUri", "ArchivedSize" and "ArchivedMD5" refer to the untouched version of the photo originally uploaded
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
PATCH
| Permissions |
|
|---|
DELETE
| Permissions |
|
|---|
Output Fields
| Altitude | integer | |
|---|---|---|
| ArchivedMD5 | text | |
| ArchivedSize | integer | |
| ArchivedUri | uri | |
| CanBuy | boolean | |
| CanEdit | boolean | |
| Caption | text | |
| Collectable | boolean | |
| Date | datetime | |
| EZProject | boolean | |
| FileName | text | |
| Format | text | |
| FormattedValues | hash | Alternative versions of certain fields formatted for use in different contexts. |
| Hidden | boolean | |
| ImageKey | text | |
| IsArchive | boolean | |
| IsVideo | boolean | |
| KeywordArray | array | |
| Keywords | text | |
| LastUpdated | timestamp | |
| Latitude | decimal | |
| Longitude | decimal | |
| OriginalHeight | integer | |
| OriginalSize | integer | |
| OriginalWidth | integer | |
| Processing | boolean | |
| Protected | boolean | |
| ThumbnailUrl | uri | |
| Title | text | |
| UploadKey | text | |
| Watermark | Deprecated as of 2014-11-20 | |
| Watermarked | boolean |
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/image/M8bZJZN-0"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"PATCH": {
"Permissions": [
"Modify"
]
},
"DELETE": {
"Permissions": [
"Modify"
]
}
},
"Methods": [
"OPTIONS",
"GET"
],
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "Title",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Caption",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Keywords",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "KeywordArray",
"Type": "Array",
"ITEM_TYPE": "Varchar",
"MIN_COUNT": 0,
"MAX_COUNT": "INFINITY"
},
{
"Name": "Watermark",
"Type": "Select",
"OPTIONS": [
"No",
"Yes",
"Inherit from Album"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1,
"Deprecated": "2014-11-20"
},
{
"Name": "Latitude",
"Type": "DECIMAL",
"PRECISION": 16,
"SCALE": 14,
"SIGNED": true
},
{
"Name": "Longitude",
"Type": "DECIMAL",
"PRECISION": 17,
"SCALE": 14,
"SIGNED": true
},
{
"Name": "Altitude",
"Type": "Integer",
"MIN_VALUE": 0,
"MAX_VALUE": 16777215
},
{
"Name": "Hidden",
"Type": "Boolean"
},
{
"Name": "ThumbnailUrl",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": []
},
{
"Name": "FileName",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Processing",
"Type": "Boolean"
},
{
"Name": "UploadKey",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Date",
"Type": "DateTime"
},
{
"Name": "Format",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "OriginalHeight",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "OriginalWidth",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "OriginalSize",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "LastUpdated",
"Type": "Timestamp"
},
{
"Name": "Collectable",
"Type": "Boolean"
},
{
"Name": "IsArchive",
"Type": "Boolean"
},
{
"Name": "IsVideo",
"Type": "Boolean"
},
{
"Name": "CanEdit",
"Type": "Boolean"
},
{
"Name": "CanBuy",
"Type": "Boolean"
},
{
"Name": "Protected",
"Type": "Boolean"
},
{
"Name": "EZProject",
"Type": "Boolean"
},
{
"Name": "Watermarked",
"Type": "Boolean"
},
{
"Name": "ImageKey",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "ArchivedUri",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": []
},
{
"Name": "ArchivedSize",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "ArchivedMD5",
"Type": "Text",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "FormattedValues",
"Description": "Alternative versions of certain fields formatted for use in different contexts.",
"Type": "Hash"
}
],
"Notes": [
"The Uri returned by this endpoint may not exist if it was recently uploaded and is being processed",
"\"Watermark\" has been deprecated in favor of \"Watermarked\".\n \"Watermarked\" will only be present for images with a known watermarked state",
"Photo sizes, including Original, without a \"Size\" or \"MD5\" property, will be generated dynamically upon request",
"\"ArchivedUri\", \"ArchivedSize\" and \"ArchivedMD5\" refer to the untouched version of the photo originally uploaded"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "image"
},
{
"type": "singleparam",
"param_name": "imagekey",
"param_value": "M8bZJZN-0"
}
]
},
"Response": {
"Uri": "/api/v2/image/M8bZJZN-0",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "",
"Caption": "",
"Keywords": "",
"KeywordArray": [],
"Watermark": "No",
"Latitude": "0.00000000000000",
"Longitude": "0.00000000000000",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/Wedding-examples/i-M8bZJZN/0/9f5b7ffc/Th/Bride4-Th.jpg",
"FileName": "Bride4.jpg",
"Processing": false,
"UploadKey": "5660058169",
"Date": "2017-01-22T23:23:22+00:00",
"Format": "JPG",
"OriginalHeight": 5020,
"OriginalWidth": 4016,
"LastUpdated": "2017-01-22T23:24:02+00:00",
"Collectable": true,
"IsArchive": false,
"IsVideo": false,
"CanEdit": false,
"CanBuy": true,
"Protected": true,
"Watermarked": false,
"ImageKey": "M8bZJZN",
"FormattedValues": {
"Caption": {
"html": "",
"text": ""
}
},
"Uri": "/api/v2/image/M8bZJZN-0",
"WebUri": "http://www.figmentation.ie/Wedding-examples/i-M8bZJZN",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/M8bZJZN-0!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/M8bZJZN-0!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/M8bZJZN-0!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/M8bZJZN!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/M8bZJZN!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/M8bZJZN!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImageAlbum": {
"Uri": "/api/v2/album/jBFqfX",
"Locator": "Album",
"LocatorType": "Object",
"UriDescription": "Album by key",
"EndpointType": "Album"
},
"UnlockAlbumDownload": {
"Uri": "/api/v2/album/jBFqfX!unlockdownload",
"UriDescription": "Unlock password-protected album download",
"EndpointType": "UnlockAlbumDownload"
},
"ImageOwner": {
"Uri": "/api/v2/user/simon-martin",
"Locator": "User",
"LocatorType": "Object",
"UriDescription": "User By Nickname",
"EndpointType": "User"
},
"ImageComments": {
"Uri": "/api/v2/image/M8bZJZN!comments",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Comments on image",
"EndpointType": "ImageComments"
},
"ImageMetadata": {
"Uri": "/api/v2/image/M8bZJZN!metadata",
"Locator": "ImageMetadata",
"LocatorType": "Object",
"UriDescription": "Metadata for image",
"EndpointType": "ImageMetadata"
},
"ImagePrices": {
"Uri": "/api/v2/image/M8bZJZN!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "ImagePrices"
}
}
},
"UriDescription": "Image by key",
"EndpointType": "Image",
"DocUri": "https://api.smugmug.com/api/v2/doc/reference/image.html",
"Timing": {
"Total": {
"time": 0.03584,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}