Deprecated
| Alternative | /api/v2/node/:nodeid!children |
|---|
Response [200 Ok]
| Uri | /api/v2/folder/user/assets/Sample-Photos-for-Trials!albums |
|---|---|
| UriDescription | Albums inside of the folder |
| EndpointType | FolderAlbums |
| Locator | Album |
| LocatorType | Objects |
Album [1 of 1]
- Sample Photos
/api/v2/album/nmJsSd
| Uri | /api/v2/album/nmJsSd |
|---|---|
| UriDescription | Album by key |
| ResponseLevel | Public |
| AlbumKey | nmJsSd |
| AllowDownloads | true |
| CanBuy | false |
| CanFavorite | false |
| CanShare | false |
| CommerceLightbox | false |
| Description | empty string |
| EXIF | true |
| External | true |
| Filenames | false |
| Geography | false |
| HasDownloadPassword | false |
| ImageCount | 25 |
| ImagesLastUpdated | 2022-10-06T21:39:48+00:00 |
| Keywords | empty string |
| LastUpdated | 2020-04-21T05:57:16+00:00 |
| Name | Sample Photos |
| NiceName | Sample-Photos |
| NodeID | c2kQcT |
| Packages | false |
| PasswordHint | empty string |
| Protected | false |
| SecurityType | None |
| SortDirection | Ascending |
| SortMethod | Date Taken |
| Title | Sample Photos |
| UrlName | Sample-Photos |
| UrlPath | /Sample-Photos-for-Trials/Sample-Photos |
| WebUri | https://assets.smugmug.com/Sample-Photos-for-Trials/Sample-Photos |
Uris
AlbumDownload
/api/v2/album/nmJsSd!download
| Uri | /api/v2/album/nmJsSd!download |
|---|---|
| UriDescription | Download album |
| EndpointType | AlbumDownload |
| Locator | Download |
| LocatorType | Objects |
AlbumHighlightImage
/api/v2/album/nmJsSd!highlightimage
| Uri | /api/v2/album/nmJsSd!highlightimage |
|---|---|
| UriDescription | Highlight image for album |
| EndpointType | AlbumHighlightImage |
| Locator | AlbumImage |
| LocatorType | Object |
AlbumImages
/api/v2/album/nmJsSd!images
| Uri | /api/v2/album/nmJsSd!images |
|---|---|
| UriDescription | Images from album |
| EndpointType | AlbumImages |
| Locator | AlbumImage |
| LocatorType | Objects |
AlbumPopularMedia
/api/v2/album/nmJsSd!popularmedia
| Uri | /api/v2/album/nmJsSd!popularmedia |
|---|---|
| UriDescription | Popular images from album |
| EndpointType | AlbumPopularMedia |
| Locator | AlbumImage |
| LocatorType | Objects |
AlbumPricelistExclusions
/api/v2/album/nmJsSd!pricelistexclusions
| Uri | /api/v2/album/nmJsSd!pricelistexclusions |
|---|---|
| UriDescription | Pricelist information for an Album |
| EndpointType | AlbumPricelistExclusions |
| Locator | AlbumPricelistExclusions |
| LocatorType | Object |
AlbumPrices
/api/v2/album/nmJsSd!prices
| Uri | /api/v2/album/nmJsSd!prices |
|---|---|
| UriDescription | Purchasable Skus |
| EndpointType | AlbumPrices |
| Locator | CatalogSkuPrice |
| LocatorType | Objects |
AlbumShareUris
/api/v2/album/nmJsSd!shareuris
| Uri | /api/v2/album/nmJsSd!shareuris |
|---|---|
| UriDescription | URIs that are useful for sharing |
| EndpointType | AlbumShareUris |
| Locator | AlbumShareUris |
| LocatorType | Object |
Folder
/api/v2/folder/user/assets/Sample-Photos-for-Trials
| Uri | /api/v2/folder/user/assets/Sample-Photos-for-Trials |
|---|---|
| UriDescription | A folder or legacy (sub)category by UrlPath |
| EndpointType | Folder |
| Locator | Folder |
| LocatorType | Object |
HighlightImage
/api/v2/highlight/node/c2kQcT
| Uri | /api/v2/highlight/node/c2kQcT |
|---|---|
| UriDescription | Highlight image for a folder, album, or page |
| EndpointType | HighlightImage |
| Locator | Image |
| LocatorType | Object |
Node
/api/v2/node/c2kQcT
| Uri | /api/v2/node/c2kQcT |
|---|---|
| UriDescription | Node with the given id. |
| EndpointType | Node |
| Locator | Node |
| LocatorType | Object |
NodeCoverImage
/api/v2/node/c2kQcT!cover
| Uri | /api/v2/node/c2kQcT!cover |
|---|---|
| UriDescription | Cover image for a folder, album, or page |
| EndpointType | NodeCoverImage |
| Locator | Image |
| LocatorType | Object |
ParentFolders
/api/v2/folder/user/assets/Sample-Photos-for-Trials!parents
| Uri | /api/v2/folder/user/assets/Sample-Photos-for-Trials!parents |
|---|---|
| UriDescription | The sequence of parent folders, from the given folder to the root |
| EndpointType | ParentFolders |
| Locator | Folder |
| LocatorType | Objects |
User
/api/v2/user/assets
| Uri | /api/v2/user/assets |
|---|---|
| UriDescription | User By Nickname |
| EndpointType | User |
| Locator | User |
| LocatorType | Object |
Request
| Uri | /api/v2/folder/user/assets/Sample-Photos-for-Trials!albums |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- _multiargs does not work at this endpoint
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/folder/user/assets/Sample-Photos-for-Trials!albums"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"POST": {
"Permissions": [
"Add"
]
}
},
"Methods": [
"OPTIONS",
"GET"
],
"ParameterDescription": {
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
},
"Parameters": {
"GET": [
{
"Name": "FolderID",
"Required": false,
"ReadOnly": false,
"Default": "",
"Type": "Varchar",
"MIN_CHARS": 5,
"MAX_CHARS": "INFINITY"
}
]
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Notes": [
"_multiargs does not work at this endpoint"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "folder"
},
{
"type": "path",
"text": "user"
},
{
"type": "singleparam",
"param_name": "nickname",
"param_value": "assets",
"param_validator": {}
},
{
"type": "multipleparam",
"param_name": "folder",
"param_value": [
"Sample-Photos-for-Trials"
],
"param_validator": {}
},
{
"type": "action",
"text": "albums"
}
],
"Deprecated": {
"Alternative": "/api/v2/node/:nodeid!children"
}
},
"Response": {
"Uri": "/api/v2/folder/user/assets/Sample-Photos-for-Trials!albums",
"Locator": "Album",
"LocatorType": "Objects",
"Album": [
{
"NiceName": "Sample-Photos",
"UrlName": "Sample-Photos",
"Title": "Sample Photos",
"Name": "Sample Photos",
"AllowDownloads": true,
"Description": "",
"EXIF": true,
"External": true,
"Filenames": false,
"Geography": false,
"Keywords": "",
"PasswordHint": "",
"Protected": false,
"SortDirection": "Ascending",
"SortMethod": "Date Taken",
"SecurityType": "None",
"CommerceLightbox": false,
"AlbumKey": "nmJsSd",
"CanBuy": false,
"CanFavorite": false,
"LastUpdated": "2020-04-21T05:57:16+00:00",
"ImagesLastUpdated": "2022-10-06T21:39:48+00:00",
"NodeID": "c2kQcT",
"ImageCount": 25,
"UrlPath": "/Sample-Photos-for-Trials/Sample-Photos",
"CanShare": false,
"HasDownloadPassword": false,
"Packages": false,
"Uri": "/api/v2/album/nmJsSd",
"WebUri": "https://assets.smugmug.com/Sample-Photos-for-Trials/Sample-Photos",
"UriDescription": "Album by key",
"Uris": {
"AlbumShareUris": {
"Uri": "/api/v2/album/nmJsSd!shareuris",
"Locator": "AlbumShareUris",
"LocatorType": "Object",
"UriDescription": "URIs that are useful for sharing",
"EndpointType": "AlbumShareUris"
},
"Node": {
"Uri": "/api/v2/node/c2kQcT",
"Locator": "Node",
"LocatorType": "Object",
"UriDescription": "Node with the given id.",
"EndpointType": "Node"
},
"NodeCoverImage": {
"Uri": "/api/v2/node/c2kQcT!cover",
"Locator": "Image",
"LocatorType": "Object",
"UriDescription": "Cover image for a folder, album, or page",
"EndpointType": "NodeCoverImage"
},
"User": {
"Uri": "/api/v2/user/assets",
"Locator": "User",
"LocatorType": "Object",
"UriDescription": "User By Nickname",
"EndpointType": "User"
},
"Folder": {
"Uri": "/api/v2/folder/user/assets/Sample-Photos-for-Trials",
"Locator": "Folder",
"LocatorType": "Object",
"UriDescription": "A folder or legacy (sub)category by UrlPath",
"EndpointType": "Folder"
},
"ParentFolders": {
"Uri": "/api/v2/folder/user/assets/Sample-Photos-for-Trials!parents",
"Locator": "Folder",
"LocatorType": "Objects",
"UriDescription": "The sequence of parent folders, from the given folder to the root",
"EndpointType": "ParentFolders"
},
"HighlightImage": {
"Uri": "/api/v2/highlight/node/c2kQcT",
"Locator": "Image",
"LocatorType": "Object",
"UriDescription": "Highlight image for a folder, album, or page",
"EndpointType": "HighlightImage"
},
"AlbumHighlightImage": {
"Uri": "/api/v2/album/nmJsSd!highlightimage",
"Locator": "AlbumImage",
"LocatorType": "Object",
"UriDescription": "Highlight image for album",
"EndpointType": "AlbumHighlightImage"
},
"AlbumImages": {
"Uri": "/api/v2/album/nmJsSd!images",
"Locator": "AlbumImage",
"LocatorType": "Objects",
"UriDescription": "Images from album",
"EndpointType": "AlbumImages"
},
"AlbumPopularMedia": {
"Uri": "/api/v2/album/nmJsSd!popularmedia",
"Locator": "AlbumImage",
"LocatorType": "Objects",
"UriDescription": "Popular images from album",
"EndpointType": "AlbumPopularMedia"
},
"AlbumDownload": {
"Uri": "/api/v2/album/nmJsSd!download",
"Locator": "Download",
"LocatorType": "Objects",
"UriDescription": "Download album",
"EndpointType": "AlbumDownload"
},
"AlbumPrices": {
"Uri": "/api/v2/album/nmJsSd!prices",
"Locator": "CatalogSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Purchasable Skus",
"EndpointType": "AlbumPrices"
},
"AlbumPricelistExclusions": {
"Uri": "/api/v2/album/nmJsSd!pricelistexclusions",
"Locator": "AlbumPricelistExclusions",
"LocatorType": "Object",
"UriDescription": "Pricelist information for an Album",
"EndpointType": "AlbumPricelistExclusions"
}
},
"ResponseLevel": "Public"
}
],
"UriDescription": "Albums inside of the folder",
"EndpointType": "FolderAlbums",
"Timing": {
"Total": {
"time": 0.03762,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}