Response [200 Ok]

Uri /api/v2/watermark
UriDescription Base URI for watermark-related operations
EndpointType WatermarkBase

Uris

Watermark
/api/v2/watermark/:watermarkid

Uri /api/v2/watermark/:watermarkid
UriDescription Watermark by ID
EndpointType Watermark
Locator Watermark
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.01455

Request

Uri /api/v2/watermark
Method GET
Version v2

Config

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

Options

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Add

Parameters

POST

Deprecated as of 2023-01-23

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/watermark"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Add"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
            "Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive",
            "Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null.   Up to a MAX_LENGTH in length.",
            "Select": "Select one option. Options should pass only the \"Value\".",
            "Boolean": "For true return type true or 1, for false type false or 0"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "Name",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 255
                },
                {
                    "Name": "ImageID",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": "NEGATIVE_INFINITY",
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "ImageUri",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Uri",
                    "MAX_LENGTH": "INFINITY",
                    "Locator": [
                        "Image"
                    ]
                },
                {
                    "Name": "Dissolve",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": 0,
                    "Type": "Integer",
                    "MIN_VALUE": 0,
                    "MAX_VALUE": 100
                },
                {
                    "Name": "Pinned",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Center",
                    "Type": "Select",
                    "OPTIONS": [
                        "Center",
                        "TopLeft",
                        "TopRight",
                        "BottomLeft",
                        "BottomRight",
                        "Tile",
                        "Top",
                        "Left",
                        "Right",
                        "Bottom"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "Thumbs",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": false,
                    "Type": "Boolean",
                    "Deprecated": "2023-01-23"
                },
                {
                    "Name": "SmallestSize",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "L",
                    "Type": "Select",
                    "OPTIONS": [
                        "Th",
                        "S",
                        "M",
                        "L",
                        "XL"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ]
    },
    "Response": {
        "Uri": "/api/v2/watermark",
        "Uris": {
            "Watermark": {
                "Uri": "/api/v2/watermark/:watermarkid",
                "Locator": "Watermark",
                "LocatorType": "Object",
                "UriDescription": "Watermark by ID",
                "EndpointType": "Watermark"
            }
        },
        "UriDescription": "Base URI for watermark-related operations",
        "EndpointType": "WatermarkBase",
        "Timing": {
            "Total": {
                "time": 0.01455,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}