SmugMug API


Tutorial

API Concepts

Advanced Topics

Live API Browser

Reference

Options requests

The HTTP specification defines a request method called OPTIONS. The specification describes this method as follows:

This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.

The SmugMug API supports the OPTIONS method. You can use it to find out what other methods an endpoint supports and what parameters those methods accept. This information will be found under the Options key in the response. You can get the same data alongside any other API response by using the _verbosity parameter.

Options Subsection Description
Methods A list of supported HTTP methods
MediaTypes A list of supported MediaTypes
Parameters Includes data about required parameters for each supported HTTP method
Parameter Description Provides details about the format of each parameter type for the endpoint
Notes General notes about the endpoint

Examples

This shows an example of an OPTIONS response for this endpoint: 

{
    "Options": {
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "application/xml",
            "text/html",
            "text/csv"
        ],
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MINCHARS to MAXCHARS (MAXCHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "nickname",
                    "Label": "NickName",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MINCHARS": 0,
                    "MAXCHARS": 25
                },
                {
                    "Name": "urlpath",
                    "Label": "UrlPath",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MINCHARS": 0,
                    "MAXCHARS": "INFINITY"
                }
            ]
        },
        "Notes": [
            "multiargs does not work at this endpoint"
        ]
    },
    "Code": 200,
    "Message": "Ok"
}

This is an example of a _verbose= response for the same endpoint: 

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2!nicknameurlpathlookup?pretty=&accept=application/json&verbose="
    },
    "Options": {
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "application/xml",
            "text/html",
            "text/csv"
        ],
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MINCHARS to MAXCHARS (MAXCHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "nickname",
                    "Label": "NickName",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MINCHARS": 0,
                    "MAXCHARS": 25
                },
                {
                    "Name": "urlpath",
                    "Label": "UrlPath",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MINCHARS": 0,
                    "MAXCHARS": "INFINITY"
                }
            ]
        },
        "Notes": [
            "multiargs does not work at this endpoint"
        ]
    },
    "Response": {
        "Uri": "/api/v2!nicknameurlpathlookup?pretty=",
        "UriDescription": "Lookup folder, album, or page by user nickname and path",
        "EndpointType": "NicknameUrlPathLookup",
        "Locator": "Folder,Album,Page",
        "LocatorType": "Object"
    },
    "Code": 200,
    "Message": "Ok"
}