Response [200 Ok]
| Uri | /api/v2/album/wh3GV9!download |
|---|---|
| UriDescription | Download album |
| EndpointType | AlbumDownload |
| Locator | Download |
| LocatorType | Objects |
Request
| Uri | /api/v2/album/wh3GV9!download |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- _multiargs does not work at this endpoint
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
PUT
Deprecated:
Use POST instead
| Permissions |
|
|---|
DELETE
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/album/wh3GV9!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": "wh3GV9",
"param_validator": {}
},
{
"type": "action",
"text": "download"
}
]
},
"Response": {
"Uri": "/api/v2/album/wh3GV9!download",
"Locator": "Download",
"LocatorType": "Objects",
"UriDescription": "Download album",
"EndpointType": "AlbumDownload",
"Timing": {
"Total": {
"time": 0.03193,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}