Response [200 Ok]
| Uri | /api/v2/node!updatealbums |
|---|---|
| UriDescription | Update the albums under one or mode nodes. |
| EndpointType | UpdateAlbums |
Request
| Uri | /api/v2/node!updatealbums?_accept=text%2Fhtml |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/node!updatealbums?_accept=text%2Fhtml"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"POST": {
"Permissions": [
"Modify"
]
}
},
"Methods": [
"OPTIONS",
"GET",
"POST"
],
"ParameterDescription": {
"Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null. Up to a MAX_LENGTH in length.",
"Boolean": "For true return type true or 1, for false type false or 0",
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"Select": "Select one option. Options should pass only the \"Value\".",
"Text": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"Array": "An indexed array of values with a length in the range MIN_COUNT to MAX_COUNT, inclusive.",
"Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive"
},
"Parameters": {
"POST": [
{
"Name": "PrintmarkUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Printmark"
]
},
{
"Name": "WatermarkUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Watermark"
]
},
{
"Name": "TemplateUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Template"
]
},
{
"Name": "AllowDownloads",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Backprinting",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 255
},
{
"Name": "BoutiquePackaging",
"Required": false,
"ReadOnly": false,
"Default": "Inherit from User",
"Type": "Select",
"OPTIONS": [
"No",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "Clean",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Comments",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Description",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Human-readable description for this node. May contain basic HTML. Some node types display this to the user; some merely use it for search engine optimization.",
"Type": "Text",
"MIN_CHARS": 0,
"MAX_CHARS": 65535
},
{
"Name": "DownloadPassword",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "EXIF",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Filenames",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Geography",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Header",
"Required": false,
"ReadOnly": false,
"Default": "Custom",
"Description": "Appearance",
"Type": "Select",
"OPTIONS": [
"Custom",
"SmugMug"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "HideOwner",
"Required": false,
"ReadOnly": false,
"Default": false,
"Description": "Whether to hide the identity of this node's owner from visitors. Only applicable to Album nodes.",
"Type": "Boolean"
},
{
"Name": "InterceptShipping",
"Required": false,
"ReadOnly": false,
"Default": "Inherit from User",
"Description": "Personal Delivery",
"Type": "Select",
"OPTIONS": [
"No",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "Keywords",
"Required": false,
"ReadOnly": false,
"Default": [],
"Description": "Array of keywords describing the content of this node. Some node types use this for search engine optimization.",
"Type": "Array",
"ITEM_TYPE": "Varchar",
"MIN_COUNT": 0,
"MAX_COUNT": "INFINITY"
},
{
"Name": "LargestSize",
"Required": false,
"ReadOnly": false,
"Default": "Original",
"Type": "Select",
"OPTIONS": [
"Medium",
"Large",
"XLarge",
"X2Large",
"X3Large",
"X4Large",
"X5Large",
"4K",
"5K",
"Original"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "PackagingBranding",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Password",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "PasswordHint",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 255
},
{
"Name": "Printable",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Privacy",
"Required": false,
"ReadOnly": false,
"Default": "Unlisted",
"Description": "Privacy level for this node. NOTE: This may be overridden by a more restrictive privacy setting inherited from one of this node's ancestors. See EffectivePrivacy.",
"Type": "Select",
"OPTIONS": [
"Public",
"Unlisted",
"Private"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "ProofDays",
"Required": false,
"ReadOnly": false,
"Default": 0,
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "ProofDigital",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Protected",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Right-Click Protection",
"Type": "Boolean"
},
{
"Name": "Share",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "Slideshow",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "SmugSearchable",
"Required": false,
"ReadOnly": false,
"Default": "Inherit from User",
"Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, Local, LocalUser, Yes\nChild nodes: No, Inherit from User",
"Type": "Select",
"OPTIONS": [
"No",
"Local",
"LocalUser",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortDirection",
"Required": false,
"ReadOnly": false,
"Default": "Ascending",
"Type": "Select",
"OPTIONS": [
"Ascending",
"Descending"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortMethod",
"Required": false,
"ReadOnly": false,
"Default": "Date Taken",
"Type": "Select",
"OPTIONS": [
"Position",
"Caption",
"Filename",
"Date Uploaded",
"Date Modified",
"Date Taken"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SquareThumbs",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "UploadKey",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Guest UploadKey",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "Watermark",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Automatically apply watermark to uploaded images?",
"Type": "Boolean"
},
{
"Name": "WorldSearchable",
"Required": false,
"ReadOnly": false,
"Default": "Inherit from User",
"Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, HomeOnly, Yes\nChild nodes: No, Inherit from User",
"Type": "Select",
"OPTIONS": [
"No",
"HomeOnly",
"Yes",
"Inherit from User"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SecurityType",
"Required": false,
"ReadOnly": false,
"Default": "None",
"Description": "Security type for this node. NOTE: This may be overridden by a more restrictive security setting inherited from one of this node's ancestors. See EffectiveSecurityType.",
"Type": "Select",
"OPTIONS": [
"None",
"Password",
"GrantAccess"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "CommerceLightbox",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "CoverImageUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "HighlightImageUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Image"
]
},
{
"Name": "ShowCoverImage",
"Required": false,
"ReadOnly": false,
"Default": true,
"Description": "Whether or not to display the cover image when possible.",
"Type": "Boolean"
},
{
"Name": "Type",
"Required": false,
"ReadOnly": false,
"Default": "Folder",
"Type": "Select",
"OPTIONS": [
"Album",
"Page",
"Folder"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "HasDownloadPassword",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Boolean"
},
{
"Name": "NodeUris",
"Required": true,
"ReadOnly": false,
"Default": [],
"Description": "JSON array of one or more node URIs containing the albums to be updated.",
"Type": "Array",
"ITEM_TYPE": "Uri",
"MIN_COUNT": 1,
"MAX_COUNT": "INFINITY"
},
{
"Name": "PricelistUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"PricelistKey"
]
}
]
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
]
},
"Response": {
"Uri": "/api/v2/node!updatealbums",
"UriDescription": "Update the albums under one or mode nodes.",
"EndpointType": "UpdateAlbums",
"Timing": {
"Total": {
"time": 0.02566,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}