Response [200 Ok]
| Uri | /api/v2/image/NCsxGMx-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]
- Bo-Kaap area of Cape Town
/api/v2/image/NCsxGMx-0
| Uri | /api/v2/image/NCsxGMx-0 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| UriDescription | Image by key | ||||||||||||||||||||
| Altitude | 0 | ||||||||||||||||||||
| CanBuy | true | ||||||||||||||||||||
| CanEdit | false | ||||||||||||||||||||
| CanShare | true | ||||||||||||||||||||
| Caption | Bo-Kaap is a colourful neighbourhod of Cape Town, South Africa, formerly known as the Malay Quarter | ||||||||||||||||||||
| Collectable | false | ||||||||||||||||||||
| Comments | true | ||||||||||||||||||||
| Date | 2019-03-04T23:47:31+00:00 | ||||||||||||||||||||
| FileName | DSC_2958.jpg | ||||||||||||||||||||
| Format | JPG | ||||||||||||||||||||
| Hidden | false | ||||||||||||||||||||
| ImageKey | NCsxGMx | ||||||||||||||||||||
| IsArchive | false | ||||||||||||||||||||
| IsVideo | false | ||||||||||||||||||||
| KeywordArray |
Array [10]
|
||||||||||||||||||||
| Keywords | Africa; BoKaap; Cape Town; Malay Quarter; South Africa; brightly coloured homes; cobble stoned streets; photo; photograph; photography | ||||||||||||||||||||
| LastUpdated | 2019-03-04T23:47:35+00:00 | ||||||||||||||||||||
| Latitude | 0.00000000000000 | ||||||||||||||||||||
| Longitude | 0.00000000000000 | ||||||||||||||||||||
| OriginalHeight | 4928 | ||||||||||||||||||||
| OriginalSize | 13438880 | ||||||||||||||||||||
| OriginalWidth | 3264 | ||||||||||||||||||||
| Processing | false | ||||||||||||||||||||
| Protected | true | ||||||||||||||||||||
| ShowKeywords | true | ||||||||||||||||||||
| ThumbnailUrl | https://photos.smugmug.com/photos/i-NCsxGMx/0/Th/i-NCsxGMx-Th.jpg | ||||||||||||||||||||
| Title | Bo-Kaap area of Cape Town | ||||||||||||||||||||
| UploadKey | 8097575777 | ||||||||||||||||||||
| Watermark | No | ||||||||||||||||||||
| Watermarked | true |
Uris
ImageComments
/api/v2/image/NCsxGMx!comments
| Uri | /api/v2/image/NCsxGMx!comments |
|---|---|
| UriDescription | Comments on image |
| EndpointType | ImageComments |
| Locator | Comment |
| LocatorType | Objects |
ImageMetadata
/api/v2/image/NCsxGMx!metadata
| Uri | /api/v2/image/NCsxGMx!metadata |
|---|---|
| UriDescription | Metadata for image |
| EndpointType | ImageMetadata |
| Locator | ImageMetadata |
| LocatorType | Object |
ImagePricelistExclusions
/api/v2/image/NCsxGMx!pricelistexclusions
| Uri | /api/v2/image/NCsxGMx!pricelistexclusions |
|---|---|
| UriDescription | Pricelist information for an image |
| EndpointType | ImagePricelistExclusions |
| Locator | ImagePricelistExclusions |
| LocatorType | Object |
ImagePrices
/api/v2/image/NCsxGMx!prices
| Uri | /api/v2/image/NCsxGMx!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | ImagePrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
ImageSizeDetails
/api/v2/image/NCsxGMx-0!sizedetails
| Uri | /api/v2/image/NCsxGMx-0!sizedetails |
|---|---|
| UriDescription | Detailed size information for image |
| EndpointType | ImageSizeDetails |
| Locator | ImageSizeDetails |
| LocatorType | Object |
ImageSizes
/api/v2/image/NCsxGMx-0!sizes
| Uri | /api/v2/image/NCsxGMx-0!sizes |
|---|---|
| UriDescription | Sizes available for image |
| EndpointType | ImageSizes |
| Locator | ImageSizes |
| LocatorType | Object |
LargestImage
/api/v2/image/NCsxGMx-0!largestimage
| Uri | /api/v2/image/NCsxGMx-0!largestimage |
|---|---|
| UriDescription | Largest size available for image |
| EndpointType | LargestImage |
| Locator | LargestImage |
| LocatorType | Object |
PointOfInterest
/api/v2/image/NCsxGMx!pointofinterest
| Uri | /api/v2/image/NCsxGMx!pointofinterest |
|---|---|
| UriDescription | Point of interest for image |
| EndpointType | PointOfInterest |
| Locator | PointOfInterest |
| LocatorType | Object |
PointOfInterestCrops
/api/v2/image/NCsxGMx!poicrops
| Uri | /api/v2/image/NCsxGMx!poicrops |
|---|---|
| UriDescription | PointOfInterest Crops for image |
| EndpointType | PointOfInterestCrops |
| Locator | PointOfInterestCrops |
| LocatorType | List |
Regions
/api/v2/image/NCsxGMx!regions
| Uri | /api/v2/image/NCsxGMx!regions |
|---|---|
| UriDescription | Regions for image |
| EndpointType | Regions |
| Locator | Region |
| LocatorType | Objects |
Request
| Uri | /api/v2/image/NCsxGMx-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 | |
| CanShare | boolean | |
| Caption | text | |
| Collectable | boolean | |
| Comments | boolean | |
| Date | 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 | |
| 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/NCsxGMx-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": "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": "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": "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": "NCsxGMx-0"
}
]
},
"Response": {
"Uri": "/api/v2/image/NCsxGMx-0",
"Locator": "Image",
"LocatorType": "Object",
"Image": {
"Title": "Bo-Kaap area of Cape Town",
"Caption": "Bo-Kaap is a colourful neighbourhod of Cape Town, South Africa, formerly known as the Malay Quarter",
"Keywords": "Africa; BoKaap; Cape Town; Malay Quarter; South Africa; brightly coloured homes; cobble stoned streets; photo; photograph; photography",
"KeywordArray": [
"Africa",
"BoKaap",
"Cape Town",
"Malay Quarter",
"South Africa",
"brightly coloured homes",
"cobble stoned streets",
"photo",
"photograph",
"photography"
],
"Watermark": "No",
"Latitude": "0.00000000000000",
"Longitude": "0.00000000000000",
"Altitude": 0,
"Hidden": false,
"ThumbnailUrl": "https://photos.smugmug.com/photos/i-NCsxGMx/0/Th/i-NCsxGMx-Th.jpg",
"FileName": "DSC_2958.jpg",
"Processing": false,
"UploadKey": "8097575777",
"Date": "2019-03-04T23:47:31+00:00",
"Format": "JPG",
"OriginalHeight": 4928,
"OriginalWidth": 3264,
"OriginalSize": 13438880,
"LastUpdated": "2019-03-04T23:47:35+00:00",
"Collectable": false,
"IsArchive": false,
"IsVideo": false,
"CanEdit": false,
"CanBuy": true,
"Protected": true,
"Watermarked": true,
"ImageKey": "NCsxGMx",
"CanShare": true,
"Comments": true,
"ShowKeywords": true,
"FormattedValues": {
"Caption": {
"html": "Bo-Kaap is a colourful neighbourhod of Cape Town, South Africa, formerly known as the Malay Quarter",
"text": "Bo-Kaap is a colourful neighbourhod of Cape Town, South Africa, formerly known as the Malay Quarter"
},
"FileName": {
"html": "DSC_2958.jpg",
"text": "DSC_2958.jpg"
}
},
"Uri": "/api/v2/image/NCsxGMx-0",
"UriDescription": "Image by key",
"Uris": {
"LargestImage": {
"Uri": "/api/v2/image/NCsxGMx-0!largestimage",
"Locator": "LargestImage",
"LocatorType": "Object",
"UriDescription": "Largest size available for image",
"EndpointType": "LargestImage"
},
"ImageSizes": {
"Uri": "/api/v2/image/NCsxGMx-0!sizes",
"Locator": "ImageSizes",
"LocatorType": "Object",
"UriDescription": "Sizes available for image",
"EndpointType": "ImageSizes"
},
"ImageSizeDetails": {
"Uri": "/api/v2/image/NCsxGMx-0!sizedetails",
"Locator": "ImageSizeDetails",
"LocatorType": "Object",
"UriDescription": "Detailed size information for image",
"EndpointType": "ImageSizeDetails"
},
"PointOfInterest": {
"Uri": "/api/v2/image/NCsxGMx!pointofinterest",
"Locator": "PointOfInterest",
"LocatorType": "Object",
"UriDescription": "Point of interest for image",
"EndpointType": "PointOfInterest"
},
"PointOfInterestCrops": {
"Uri": "/api/v2/image/NCsxGMx!poicrops",
"Locator": "PointOfInterestCrops",
"LocatorType": "List",
"UriDescription": "PointOfInterest Crops for image",
"EndpointType": "PointOfInterestCrops"
},
"Regions": {
"Uri": "/api/v2/image/NCsxGMx!regions",
"Locator": "Region",
"LocatorType": "Objects",
"UriDescription": "Regions for image",
"EndpointType": "Regions"
},
"ImageComments": {
"Uri": "/api/v2/image/NCsxGMx!comments",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Comments on image",
"EndpointType": "ImageComments"
},
"ImageMetadata": {
"Uri": "/api/v2/image/NCsxGMx!metadata",
"Locator": "ImageMetadata",
"LocatorType": "Object",
"UriDescription": "Metadata for image",
"EndpointType": "ImageMetadata"
},
"ImagePrices": {
"Uri": "/api/v2/image/NCsxGMx!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "ImagePrices"
},
"ImagePricelistExclusions": {
"Uri": "/api/v2/image/NCsxGMx!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.06461,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}
