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/93p5TRQ-0!sizecustom?height=360&width=640"
    },
    "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",
                    "Value": "640"
                },
                {
                    "Name": "height",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Integer",
                    "MIN_VALUE": 1,
                    "MAX_VALUE": "POSITIVE_INFINITY",
                    "Value": "360"
                },
                {
                    "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": "93p5TRQ-0",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "sizecustom"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/93p5TRQ-0!sizecustom?height=360&width=640",
        "Locator": "ImageSizeCustom",
        "LocatorType": "Object",
        "ImageSizeCustom": {
            "Url": "https://photos.smugmug.com/Great-Lakes-Region/Ohio-Wing/Squadrons/OH-145-Lt-Col-Jerome-P-Ashman-Composite-Squadron/OH-145-2021-Photo-and-Video-Gallery/i-93p5TRQ/0/M5N4TjrLj3xRSqCP8dXfj6sNgdttkR7VkDJhRLZ6c/640x360/Volunteer%20Event_05_15_2021-640x360.jpg",
            "RequestedHeight": 360,
            "RequestedWidth": 640,
            "RequestedFill": false,
            "Height": 640,
            "Width": 360,
            "Usable": true,
            "Ext": "jpg",
            "Watermarked": false,
            "Uri": "/api/v2/image/93p5TRQ-0!sizecustom?height=360&width=640",
            "UriDescription": "Image size: custom"
        },
        "UriDescription": "Image size: custom",
        "EndpointType": "ImageSizeCustom",
        "Timing": {
            "Total": {
                "time": 0.10681,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}