Response [200 Ok]
| Uri | /api/v2/image/sffL4mc-1 |
|---|---|
| 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/sffL4mc-1
| Uri | /api/v2/image/sffL4mc-1 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| UriDescription | Image by key | ||||||||||||||||||||||||
| Altitude | 0 | ||||||||||||||||||||||||
| CanBuy | true | ||||||||||||||||||||||||
| CanEdit | false | ||||||||||||||||||||||||
| CanShare | true | ||||||||||||||||||||||||
| Caption | 12308_2017_MCSANTC_MTB_20170219.dng <br><br> Published on page 33 of Squash Magazine (October 2017) | ||||||||||||||||||||||||
| Collectable | false | ||||||||||||||||||||||||
| Comments | true | ||||||||||||||||||||||||
| Date | 2017-03-15T04:39:01+00:00 | ||||||||||||||||||||||||
| DateTimeOriginal | 2017-02-19T23:53:02+00:00 | ||||||||||||||||||||||||
| DateTimeUploaded | 2017-03-15T04:39:01+00:00 | ||||||||||||||||||||||||
| FileName | 12308_2017_MCSANTC_MTB_20170219.jpg | ||||||||||||||||||||||||
| Format | JPG | ||||||||||||||||||||||||
| Hidden | false | ||||||||||||||||||||||||
| ImageKey | sffL4mc | ||||||||||||||||||||||||
| IsArchive | false | ||||||||||||||||||||||||
| IsVideo | false | ||||||||||||||||||||||||
| KeywordArray |
Array [12]
|
||||||||||||||||||||||||
| Keywords | 2017 Men's College Squash Association National Team Championships; CSA Men; College Squash; Harvard; Highlight; Kush Kumar; Saadeldin Abouaish; Squash; Trinity; Published; Squash Magazine; Portfolio | ||||||||||||||||||||||||
| LastUpdated | 2017-10-09T21:13:40+00:00 | ||||||||||||||||||||||||
| Latitude | 42.36754500000000 | ||||||||||||||||||||||||
| Longitude | -71.12586666666700 | ||||||||||||||||||||||||
| OriginalHeight | 2832 | ||||||||||||||||||||||||
| OriginalSize | 8819671 | ||||||||||||||||||||||||
| OriginalWidth | 4256 | ||||||||||||||||||||||||
| Processing | false | ||||||||||||||||||||||||
| Protected | true | ||||||||||||||||||||||||
| Serial | 1 | ||||||||||||||||||||||||
| ShowKeywords | true | ||||||||||||||||||||||||
| ThumbnailUrl | https://photos.smugmug.com/photos/i-sffL4mc/1/Th/i-sffL4mc-Th.jpg | ||||||||||||||||||||||||
| Title | empty string | ||||||||||||||||||||||||
| UploadKey | 5776505655 | ||||||||||||||||||||||||
| Watermark | No | ||||||||||||||||||||||||
| Watermarked | true |
Formatted Values
Caption [html, text]
| html | 12308_2017_MCSANTC_MTB_20170219.dng <br><br> Published on page 33 of Squash Magazine (October 2017) |
|---|---|
| text | 12308_2017_MCSANTC_MTB_20170219.dng Published on page 33 of Squash Magazine (October 2017) |
FileName [html, text]
| html | 12308_2017_MCSANTC_MTB_20170219.jpg |
|---|---|
| text | 12308_2017_MCSANTC_MTB_20170219.jpg |
Uris
ImageComments
/api/v2/image/sffL4mc!comments
| Uri | /api/v2/image/sffL4mc!comments |
|---|---|
| UriDescription | Comments on image |
| EndpointType | ImageComments |
| Locator | Comment |
| LocatorType | Objects |
ImageMetadata
/api/v2/image/sffL4mc!metadata
| Uri | /api/v2/image/sffL4mc!metadata |
|---|---|
| UriDescription | Metadata for image |
| EndpointType | ImageMetadata |
| Locator | ImageMetadata |
| LocatorType | Object |
ImagePricelistExclusions
/api/v2/image/sffL4mc!pricelistexclusions
| Uri | /api/v2/image/sffL4mc!pricelistexclusions |
|---|---|
| UriDescription | Pricelist information for an image |
| EndpointType | ImagePricelistExclusions |
| Locator | ImagePricelistExclusions |
| LocatorType | Object |
ImagePrices
/api/v2/image/sffL4mc!prices
| Uri | /api/v2/image/sffL4mc!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/sffL4mc-1!sizedetails
| Uri | /api/v2/image/sffL4mc-1!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/sffL4mc-1!sizes
| Uri | /api/v2/image/sffL4mc-1!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/sffL4mc-1!largestimage
| Uri | /api/v2/image/sffL4mc-1!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/sffL4mc!pointofinterest
| Uri | /api/v2/image/sffL4mc!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/sffL4mc!poicrops
| Uri | /api/v2/image/sffL4mc!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/sffL4mc!regions
| Uri | /api/v2/image/sffL4mc!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
Request
| Uri | /api/v2/image/sffL4mc-1 |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
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 | |
| CanShare | boolean | |
| Caption | text | |
| Collectable | boolean | |
| Comments | boolean | |
| ComponentFileTypes | hash | |
| Date | Deprecated as of 2020-07-17 | Use DateTimeUploaded |
| DateTimeOriginal | datetimeiso8601 | |
| DateTimeUploaded | datetimeiso8601 | |
| 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 | datetimeiso8601 | |
| Latitude | decimal | |
| Longitude | decimal | |
| OriginalHeight | integer | |
| OriginalSize | integer | |
| OriginalWidth | integer | |
| Processing | boolean | |
| Protected | boolean | |
| Serial | integer | |
| ShowKeywords | 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/sffL4mc-1"
},
"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",
"Description": "Use DateTimeUploaded",
"Type": "DateTimeISO8601",
"Deprecated": "2020-07-17"
},
{
"Name": "DateTimeUploaded",
"Type": "DateTimeISO8601"
},
{
"Name": "DateTimeOriginal",
"Type": "DateTimeISO8601"
},
{
"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": "DateTimeISO8601"
},
{
"Name": "Collectable",
"Type": "Boolean"
},
{
"Name": "IsArchive",
"Type": "Boolean"
},
{
"Name": "IsVideo",
"Type": "Boolean"
},
{
"Name": "ComponentFileTypes",
"Type": "Hash"
},
{
"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": "Serial",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_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": "CanShare",
"Type": "Boolean"
},
{
"Name": "Comments",
"Type": "Boolean"
},
{
"Name": "ShowKeywords",
"Type": "Boolean"
},
{
"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": "sffL4mc-1"
}
]
},
"Response": {
"Uri": "/api/v2/image/sffL4mc-1",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "",
"Caption": "12308_2017_MCSANTC_MTB_20170219.dng\n<br><br>\nPublished on page 33 of Squash Magazine (October 2017)",
"Keywords": "2017 Men's College Squash Association National Team Championships; CSA Men; College Squash; Harvard; Highlight; Kush Kumar; Saadeldin Abouaish; Squash; Trinity; Published; Squash Magazine; Portfolio",
"KeywordArray": [
"2017 Men's College Squash Association National Team Championships",
"CSA Men",
"College Squash",
"Harvard",
"Highlight",
"Kush Kumar",
"Saadeldin Abouaish",
"Squash",
"Trinity",
"Published",
"Squash Magazine",
"Portfolio"
],
"Watermark": "No",
"Latitude": "42.36754500000000",
"Longitude": "-71.12586666666700",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/photos/i-sffL4mc/1/Th/i-sffL4mc-Th.jpg",
"FileName": "12308_2017_MCSANTC_MTB_20170219.jpg",
"Processing": false,
"UploadKey": "5776505655",
"Date": "2017-03-15T04:39:01+00:00",
"DateTimeUploaded": "2017-03-15T04:39:01+00:00",
"DateTimeOriginal": "2017-02-19T23:53:02+00:00",
"Format": "JPG",
"OriginalHeight": 2832,
"OriginalWidth": 4256,
"OriginalSize": 8819671,
"LastUpdated": "2017-10-09T21:13:40+00:00",
"Collectable": false,
"IsArchive": false,
"IsVideo": false,
"CanEdit": false,
"CanBuy": true,
"Protected": true,
"Watermarked": true,
"ImageKey": "sffL4mc",
"Serial": 1,
"CanShare": true,
"Comments": true,
"ShowKeywords": true,
"FormattedValues": {
"Caption": {
"html": "12308_2017_MCSANTC_MTB_20170219.dng\n<br><br>\nPublished on page 33 of Squash Magazine (October 2017)",
"text": "12308_2017_MCSANTC_MTB_20170219.dng\n\nPublished on page 33 of Squash Magazine (October 2017)"
},
"FileName": {
"html": "12308_2017_MCSANTC_MTB_20170219.jpg",
"text": "12308_2017_MCSANTC_MTB_20170219.jpg"
}
},
"Uri": "/api/v2/image/sffL4mc-1",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/sffL4mc-1!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/sffL4mc-1!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/sffL4mc-1!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/sffL4mc!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/sffL4mc!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/sffL4mc!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImageComments": {
"Uri": "/api/v2/image/sffL4mc!comments",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Comments on image",
"EndpointType": "ImageComments"
},
"ImageMetadata": {
"Uri": "/api/v2/image/sffL4mc!metadata",
"Locator": "ImageMetadata",
"LocatorType": "Object",
"UriDescription": "Metadata for image",
"EndpointType": "ImageMetadata"
},
"ImagePrices": {
"Uri": "/api/v2/image/sffL4mc!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "ImagePrices"
},
"ImagePricelistExclusions": {
"Uri": "/api/v2/image/sffL4mc!pricelistexclusions",
"Locator": "ImagePricelistExclusions",
"LocatorType": "Object",
"UriDescription": "Pricelist information for an image",
"EndpointType": "ImagePricelistExclusions"
}
}
},
"UriDescription": "Image by key",
"EndpointType": "Image",
"DocUri": "https://api.smugmug.com/api/v2/doc/reference/image.html",
"Timing": {
"Total": {
"time": 0.05518,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}