Response [200 Ok]

Uri /api/v2/image/WLQHxsW-0!sizecustom
UriDescription Image size: custom
EndpointType ImageSizeCustom
Locator ImageSizeCustom
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.03882

Request

Uri /api/v2/image/WLQHxsW-0!sizecustom
Method GET
Version v2

Config

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

Options

Path

  • /api
  • /v2
  • /image
  • /
  • !sizecustom

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

Should the resulting image fill the requested size rather than fit it?

Output Fields

Ext text
Height integer
RequestedFill boolean
RequestedHeight integer
RequestedWidth integer
Url uri
Usable boolean
Watermarked boolean
Width integer

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image/WLQHxsW-0!sizecustom"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "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": {
            "GET": [
                {
                    "Name": "width",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": 1,
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "height",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": 1,
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "fill",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": false,
                    "Description": "Should the resulting image fill the requested size rather than fit it?",
                    "Type": "Boolean"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "Url",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": []
            },
            {
                "Name": "RequestedHeight",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "RequestedWidth",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "RequestedFill",
                "Type": "Boolean"
            },
            {
                "Name": "Height",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "Width",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "Usable",
                "Type": "Boolean"
            },
            {
                "Name": "Ext",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Watermarked",
                "Type": "Boolean"
            }
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "WLQHxsW-0",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "sizecustom"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/WLQHxsW-0!sizecustom",
        "Locator": "ImageSizeCustom",
        "LocatorType": "Object",
        "ImageSizeCustom": {
            "Uri": "/api/v2/image/WLQHxsW-0!sizecustom",
            "UriDescription": "Image size: custom"
        },
        "UriDescription": "Image size: custom",
        "EndpointType": "ImageSizeCustom",
        "Timing": {
            "Total": {
                "time": 0.03882,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}