Response [200 Ok]

Uri /api/v2/image!search
UriDescription Search for images
EndpointType ImageSearch
Locator ImageSearchResult
LocatorType Objects

Pages

Count 0
FirstPage /api/v2/image!search?start=1&count=10
LastPage /api/v2/image!search?start=-9&count=10
RequestedCount 10
Start 1
Total 0

Timing

Total

cycles 1
objects 0
time 0.01879

Request

Uri /api/v2/image!search
Method GET
Version v2

Options

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

Single keyword or JSON encoded array of keywords to search for
The URI of an Album, Folder, Node, or User to search within
Search all text fields

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image!search"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
            "Select": "Select MIN_COUNT to MAX_COUNT options.  Options should pass only the \"Value\".  When passing more then one value, use an array.",
            "Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null.   Up to a MAX_LENGTH in length.",
            "Array": "An indexed array of values with a length in the range MIN_COUNT to MAX_COUNT, inclusive."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "Text",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Search all text fields",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "SortMethod",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Popular",
                    "Type": "Select",
                    "OPTIONS": [
                        "Popular",
                        "DateUploaded",
                        "DateTaken"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "SortDirection",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Descending",
                    "Type": "Select",
                    "OPTIONS": [
                        "Ascending",
                        "Descending"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "Scope",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "The URI of an Album, Folder, Node, or User to search within",
                    "Type": "Uri",
                    "MAX_LENGTH": "INFINITY",
                    "Locator": []
                },
                {
                    "Name": "Keywords",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Single keyword or JSON encoded array of keywords to search for",
                    "Type": "Array",
                    "ITEM_TYPE": "Varchar",
                    "MIN_COUNT": 0,
                    "MAX_COUNT": "INFINITY"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "_multiargs does not work at this endpoint"
        ]
    },
    "Response": {
        "Uri": "/api/v2/image!search",
        "Locator": "ImageSearchResult",
        "LocatorType": "Objects",
        "UriDescription": "Search for images",
        "EndpointType": "ImageSearch",
        "Pages": {
            "Total": 0,
            "Start": 1,
            "Count": 0,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/image!search?start=1\u0026count=10",
            "LastPage": "/api/v2/image!search?start=-9\u0026count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.01879,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}