Response [200 Ok]

Uri /api/v2!nicknameurlpathlookup
UriDescription Lookup folder, album, or page by user nickname and path
EndpointType NicknameUrlPathLookup
Locator Folder,Album,Page
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.02174

Request

Uri /api/v2!nicknameurlpathlookup
Method GET
Version v2

Config

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

Options

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2!nicknameurlpathlookup"
    },
    "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)"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "nickname",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 25
                },
                {
                    "Name": "urlpath",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "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!nicknameurlpathlookup",
        "Locator": "Folder,Album,Page",
        "LocatorType": "Object",
        "UriDescription": "Lookup folder, album, or page by user nickname and path",
        "EndpointType": "NicknameUrlPathLookup",
        "Timing": {
            "Total": {
                "time": 0.02174,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}