Response [200 Ok]
| Uri | /api/v2/image/9q3MLWg-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/9q3MLWg-0
| Uri | /api/v2/image/9q3MLWg-0 |
|---|---|
| UriDescription | Image by key |
| Altitude | 0 |
| CanBuy | false |
| CanEdit | false |
| Caption | Photography by David Lane (www.memorylane.ie) |
| Collectable | false |
| Date | 2016-10-10T11:12:50+00:00 |
| FileName | SM_urbanrun 2016_-15.jpg |
| Format | JPG |
| Hidden | false |
| ImageKey | 9q3MLWg |
| IsArchive | false |
| IsVideo | false |
| KeywordArray | |
| Keywords | empty string |
| LastUpdated | 2016-10-10T11:12:54+00:00 |
| Latitude | 0.00000000000000 |
| Longitude | 0.00000000000000 |
| OriginalHeight | 1400 |
| OriginalSize | 1799213 |
| OriginalWidth | 2100 |
| Processing | false |
| Protected | false |
| ThumbnailUrl | https://photos.smugmug.com/Clients2/SMRC-Urban-Run/i-9q3MLWg/0/b94ac79b/Th/SM_urbanrun%202016_-15-Th.jpg |
| Title | empty string |
| UploadKey | 5369355898 |
| Watermark | No |
| Watermarked | false |
| WebUri | http://www.memorylane.ie/Clients2/SMRC-Urban-Run/i-9q3MLWg |
Formatted Values
Caption [html, text]
| html | Photography by David Lane ( <a href="http://www.memorylane.ie">http://www.memorylane.ie</a>) |
|---|---|
| text | Photography by David Lane (www.memorylane.ie) |
Uris
ImageAlbum
/api/v2/album/NpBHhC
| Uri | /api/v2/album/NpBHhC |
|---|---|
| UriDescription | Album by key |
| EndpointType | Album |
| Locator | Album |
| LocatorType | Object |
ImageComments
/api/v2/image/9q3MLWg!comments
| Uri | /api/v2/image/9q3MLWg!comments |
|---|---|
| UriDescription | Comments on image |
| EndpointType | ImageComments |
| Locator | Comment |
| LocatorType | Objects |
ImageDownload
/api/v2/image/9q3MLWg!download
| Uri | /api/v2/image/9q3MLWg!download |
|---|---|
| UriDescription | Download image |
| EndpointType | ImageDownload |
| Locator | ImageDownload |
| LocatorType | Object |
ImageOwner
/api/v2/user/davidmemorylane
| Uri | /api/v2/user/davidmemorylane |
|---|---|
| UriDescription | User By Nickname |
| EndpointType | User |
| Locator | User |
| LocatorType | Object |
ImagePrices
/api/v2/image/9q3MLWg!prices
| Uri | /api/v2/image/9q3MLWg!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/9q3MLWg-0!sizedetails
| Uri | /api/v2/image/9q3MLWg-0!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/9q3MLWg-0!sizes
| Uri | /api/v2/image/9q3MLWg-0!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/9q3MLWg-0!largestimage
| Uri | /api/v2/image/9q3MLWg-0!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/9q3MLWg!pointofinterest
| Uri | /api/v2/image/9q3MLWg!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/9q3MLWg!poicrops
| Uri | /api/v2/image/9q3MLWg!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/9q3MLWg!regions
| Uri | /api/v2/image/9q3MLWg!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
Request
| Uri | /api/v2/image/9q3MLWg-0?_accept=text%2Fhtml |
|---|---|
| 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/9q3MLWg-0?_accept=text%2Fhtml"
},
"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": "9q3MLWg-0"
}
]
},
"Response": {
"Uri": "/api/v2/image/9q3MLWg-0",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "",
"Caption": "Photography by David Lane (www.memorylane.ie)",
"Keywords": "",
"KeywordArray": [],
"Watermark": "No",
"Latitude": "0.00000000000000",
"Longitude": "0.00000000000000",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/Clients2/SMRC-Urban-Run/i-9q3MLWg/0/b94ac79b/Th/SM_urbanrun%202016_-15-Th.jpg",
"FileName": "SM_urbanrun 2016_-15.jpg",
"Processing": false,
"UploadKey": "5369355898",
"Date": "2016-10-10T11:12:50+00:00",
"Format": "JPG",
"OriginalHeight": 1400,
"OriginalWidth": 2100,
"OriginalSize": 1799213,
"LastUpdated": "2016-10-10T11:12:54+00:00",
"Collectable": false,
"IsArchive": false,
"IsVideo": false,
"CanEdit": false,
"CanBuy": false,
"Protected": false,
"Watermarked": false,
"ImageKey": "9q3MLWg",
"FormattedValues": {
"Caption": {
"html": "Photography by David Lane ( <a href=\"http://www.memorylane.ie\">http://www.memorylane.ie</a>)",
"text": "Photography by David Lane (www.memorylane.ie)"
}
},
"Uri": "/api/v2/image/9q3MLWg-0",
"WebUri": "http://www.memorylane.ie/Clients2/SMRC-Urban-Run/i-9q3MLWg",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/9q3MLWg-0!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/9q3MLWg-0!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/9q3MLWg-0!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/9q3MLWg!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/9q3MLWg!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/9q3MLWg!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImageAlbum": {
"Uri": "/api/v2/album/NpBHhC",
"Locator": "Album",
"LocatorType": "Object",
"UriDescription": "Album by key",
"EndpointType": "Album"
},
"ImageDownload": {
"Uri": "/api/v2/image/9q3MLWg!download",
"Locator": "ImageDownload",
"LocatorType": "Object",
"UriDescription": "Download image",
"EndpointType": "ImageDownload"
},
"ImageOwner": {
"Uri": "/api/v2/user/davidmemorylane",
"Locator": "User",
"LocatorType": "Object",
"UriDescription": "User By Nickname",
"EndpointType": "User"
},
"ImageComments": {
"Uri": "/api/v2/image/9q3MLWg!comments",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Comments on image",
"EndpointType": "ImageComments"
},
"ImagePrices": {
"Uri": "/api/v2/image/9q3MLWg!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.03155,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}