MyLibrary Trash Folder
Whenever a library file is deleted using either the MyLibrary Individual Files API or the GUI, it is moved to the system's Trash folder. Use this endpoint to view (GET) or to permanently DELETE the files in the Trash folder.
Methods:
Click a method to view its documentation
DescriptionTOP
Privileges required: mylibrary:file:read
Retrieve all files in the Trash folder. You can specify the type of files to retrieve using the type query parameter. You can sort the output using the sort_by query parameter.
|
GET: https://api.constantcontact.com/v2/library/folders/trash/files |
|||
name |
type |
default |
description |
|---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
limit |
query |
50 |
Specifies the number of results displayed per page of output, from 1 - 1000, default = 50. See Paginated Output for more information on using |
sort_by |
query |
CREATED_DATE_DESC |
Specifies how the list of files is sorted; valid sort options are:
|
type |
query |
ALL |
Specifies the type of files to retrieve, ALL, IMAGES, or DOCUMENTS |
Response CodesTOP
code |
description |
|---|---|
200 |
Request was successful |
401 |
Authentication failure |
406 |
Unsupported Accept Header value, must be application/json |
500 |
Internal server error occurred |
StructureTOP
|
property |
type(max length) |
description |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
created_date |
string |
Date the file was added to MyLibrary, in ISO-8601 format |
|||||||||
|
description |
string (100) |
Description of the file provided by user |
|||||||||
|
file_type |
string |
Specifies the file type, valid values are: JPEG, JPG, GIF, PDF, PNG |
|||||||||
|
folder |
string (80) |
Name of the folder the file is in |
|||||||||
|
folder_id |
string |
Unique ID of the folder the file is in |
|||||||||
|
height |
integer |
The height in pixels of the image |
|||||||||
|
id |
string |
Unique ID for the file |
|||||||||
|
is_image |
boolean |
Identifies whether the file is an image (true) or not (false) |
|||||||||
|
modified_date |
string |
Date the file was last updated in MyLibrary, in ISO-8601 format |
|||||||||
|
name |
string (80) |
Filename and extension |
|||||||||
|
size |
integer |
The size of the file (in bytes) |
|||||||||
|
source |
string |
Indicate the source of the original file; image files can be uploaded from the following sources
|
|||||||||
|
status |
string |
Indicates the file status:
|
|||||||||
|
+ thumbnail |
array |
Thumbnail image of the file |
|||||||||
|
|||||||||||
|
url |
string |
The URL of the file |
|||||||||
|
width |
integer |
The width (in pixels) of the image |
|||||||||
Example ResponseTOP
{
"meta": {
"pagination": {}
},
"results": [{
"name": "menu_form.pdf",
"id": "9",
"description": "Menu template for banquets",
"folder": "Documents",
"height": 0,
"width": 0,
"size": 2171188,
"url": "https://origin.library.constantcontact.com/doc209/1100325770405/doc/amV3YkP05yStjF2F.pdf",
"source": "MyComputer",
"type": "PDF",
"status": "Deleted",
"thumbnail": {
"url": "https://imgssl.constantcontact.com/ui/images1/mlui/mlui_document.png",
"height": 200,
"width": 178
},
"created_date": "2013-06-19T11:45:41.000-04:00",
"modified_date": "2013-09-25T15:32:26.000-04:00",
"folder_id": "-3",
"is_image": false
}, {
"name": "IMG_0257.JPG",
"id": "7",
"description": "competition",
"folder": "Sports_images",
"height": 320,
"width": 240,
"size": 130761,
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/7.jpg",
"source": "MyComputer",
"type": "JPG",
"status": "Deleted",
"thumbnail": {
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/7.jpg",
"height": 200,
"width": 150
},
"created_date": "2013-06-19T11:45:41.000-04:00",
"modified_date": "2013-09-25T15:32:26.000-04:00",
"folder_id": "-2",
"is_image": true
}, {
"name": "IMG_0300(1).JPG",
"id": "6",
"description": "Rich",
"folder": "Images",
"height": 800,
"width": 600,
"size": 60225,
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/6.jpg",
"source": "MyComputer",
"type": "JPG",
"status": "Deleted",
"thumbnail": {
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/6.jpg",
"height": 200,
"width": 150
},
"created_date": "2013-06-19T11:45:41.000-04:00",
"modified_date": "2013-09-25T15:32:26.000-04:00",
"folder_id": "-1",
"is_image": true
}, {
"name": "IMG_0300.JPG",
"id": "5",
"description": "Rich",
"folder": "Images",
"height": 600,
"width": 800,
"size": 39351,
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/5.jpg",
"source": "MyComputer",
"type": "JPG",
"status": "Deleted",
"thumbnail": {
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/5.jpg",
"height": 150,
"width": 200
},
"created_date": "2013-06-19T11:45:41.000-04:00",
"modified_date": "2013-09-25T15:32:26.000-04:00",
"folder_id": "-1",
"is_image": true
}, {
"name": "IMG_0279.JPG",
"id": "4",
"description": "pet shopping",
"folder": "Images",
"height": 600,
"width": 800,
"size": 78071,
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/4.jpg",
"source": "MyComputer",
"type": "JPG",
"status": "Deleted",
"thumbnail": {
"url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/4.jpg",
"height": 150,
"width": 200
},
"created_date": "2013-06-19T11:45:41.000-04:00",
"modified_date": "2013-09-25T15:32:26.000-04:00",
"folder_id": "-1",
"is_image": true
}]
}