Response [200 Ok]

Uri /api/v2/album/TwgBTM!download
UriDescription Download album
EndpointType AlbumDownload
Locator Download
LocatorType Objects

Timing

Total

cycles 1
objects 0
time 0.02171

Request

Uri /api/v2/album/TwgBTM!download
Method GET
Version v2

Config

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

Options

Path

  • /api
  • /v2
  • /album
  • /
  • !download

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Add

PUT
Deprecated: Use POST instead

Permissions
  • Add

DELETE

Permissions
  • Modify

Parameters

POST

The email address to receive download verification.

DELETE

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/album/TwgBTM!download"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Add"
                ]
            },
            "PUT": {
                "Permissions": [
                    "Add"
                ],
                "Deprecated": "Use POST instead"
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST",
            "DELETE"
        ],
        "ParameterDescription": {
            "Email": "Email address of the form RECIPIENT@DOMAIN"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "Email",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "The email address to receive download verification.",
                    "Type": "Email",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 255
                }
            ],
            "DELETE": []
        },
        "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": "TwgBTM",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "download"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/album/TwgBTM!download",
        "Locator": "Download",
        "LocatorType": "Objects",
        "UriDescription": "Download album",
        "EndpointType": "AlbumDownload",
        "Timing": {
            "Total": {
                "time": 0.02171,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}