Response [200 Ok]

Uri /api/v2/album/5M6Chh!images?start=-99&count=100
UriDescription Images from album
EndpointType AlbumImages
Locator AlbumImage
LocatorType Objects

Pages

Count 0
FirstPage /api/v2/album/5M6Chh!images?start=1&count=100
LastPage /api/v2/album/5M6Chh!images?start=-99&count=100
RequestedCount 100
Start 1
Total 0

Timing

Total

cycles 1
objects 0
time 0.03732

Config

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

Options

Path

  • /api
  • /v2
  • /album
  • /
  • !images

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Add

Parameters

GET

A list of filenames (percent-encoded and comma-separated); if used, an image will only be included in the result set if its file name is in the list
An optional SKU ID filter. Only images that are valid for this SKU will be returned

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/album/5M6Chh!images?start=-99&count=100"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Add"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "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"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "FileNames",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "",
                    "Description": "A list of filenames (percent-encoded and comma-separated); if used, an image will only be included in the result set if its file name is in the list",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "SkuId",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "An optional SKU ID filter. Only images that are valid for this SKU will be returned",
                    "Type": "Integer",
                    "MIN_VALUE": 0,
                    "MAX_VALUE": "POSITIVE_INFINITY"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "_multiargs does not work at this endpoint"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "album"
            },
            {
                "type": "singleparam",
                "param_name": "albumkey",
                "param_value": "5M6Chh",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "images"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/album/5M6Chh!images?start=-99&count=100",
        "Locator": "AlbumImage",
        "LocatorType": "Objects",
        "UriDescription": "Images from album",
        "EndpointType": "AlbumImages",
        "Pages": {
            "Total": 0,
            "Start": 1,
            "Count": 0,
            "RequestedCount": 100,
            "FirstPage": "/api/v2/album/5M6Chh!images?start=1&count=100",
            "LastPage": "/api/v2/album/5M6Chh!images?start=-99&count=100"
        },
        "Timing": {
            "Total": {
                "time": 0.03732,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}