Response [200 Ok]

Timing

Total

cycles 1
objects 0
time 0.01457

Request

Uri /api/v2/album/:albumkey/image/web.pr-pr
Method OPTIONS
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /album
  • /
  • /image
  • /

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Parameters

PATCH

Altitude integer
Caption text
Hidden boolean
KeywordArray array
Keywords text
Latitude decimal
Longitude decimal
Title text
Watermark Deprecated as of 2014-11-20

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "OPTIONS",
        "Uri": "/api/v2/album/:albumkey/image/web.pr-pr"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "PATCH",
            "DELETE"
        ],
        "ParameterDescription": {
            "Varchar": "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.",
            "Select": "Select one option. Options should pass only the \"Value\".",
            "DECIMAL": "Decimal character of PRECISION digits with SCALE digits to the right of the decimal point.  SIGNED indicates if the decimal number can be negative (true) or only positive (false).  Passed as strings.",
            "Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive",
            "Boolean": "For true return type true or 1, for false type false or 0"
        },
        "Parameters": {
            "PATCH": [
                {
                    "Name": "Title",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "Caption",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "Keywords",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "KeywordArray",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Array",
                    "ITEM_TYPE": "Varchar",
                    "MIN_COUNT": 0,
                    "MAX_COUNT": "INFINITY"
                },
                {
                    "Name": "Watermark",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "No",
                    "Type": "Select",
                    "OPTIONS": [
                        "No",
                        "Yes",
                        "Inherit from Album"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1,
                    "Deprecated": "2014-11-20"
                },
                {
                    "Name": "Latitude",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "0",
                    "Type": "DECIMAL",
                    "PRECISION": 16,
                    "SCALE": 14,
                    "SIGNED": true
                },
                {
                    "Name": "Longitude",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "0",
                    "Type": "DECIMAL",
                    "PRECISION": 17,
                    "SCALE": 14,
                    "SIGNED": true
                },
                {
                    "Name": "Altitude",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": 0,
                    "Type": "Integer",
                    "MIN_VALUE": 0,
                    "MAX_VALUE": 16777215
                },
                {
                    "Name": "Hidden",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Boolean"
                }
            ],
            "DELETE": []
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "album"
            },
            {
                "type": "singleparam",
                "param_name": "albumkey",
                "param_value": null
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "web.pr-pr"
            }
        ]
    },
    "Code": 200,
    "Message": "Ok",
    "Response": {
        "Timing": {
            "Total": {
                "time": 0.01457,
                "cycles": 1,
                "objects": 0
            }
        }
    }
}