Individual Library Files
Use this endpoint to retrieve (GET) and update (PUT) information for a specific Library file, and to DELETE one or more files. To create (POST) a file, use the Library File Collection POST method.
Methods:
Click a method to view its documentation
DescriptionTOP
Privileges required: mylibrary:file:read
Retrieve a MyLibrary file using the fileId path parameter.
|
GET: https://api.constantcontact.com/v2/library/files/{fileId} |
|||
name |
type |
default |
description |
|---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
fileId |
path |
Specifies the MyLibrary file for which to retrieve information |
|
Response CodesTOP
code |
description |
|---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
File with the supplied ID was not found |
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
{
"name": "IMG_0261.JPG",
"id": "4",
"description": "chocolates",
"folder": "Images",
"height": 600,
"width": 800,
"size": 68825,
"url": "https://origin.ih.l1.constantcontact.com/fs115/1100310339939/img/4.jpg",
"source": "MyComputer",
"status": "Active",
"thumbnail": {
"url": "https://origin.ih.l1.constantcontact.com/fs115/1100310339939/img/4.jpg",
"height": 150,
"width": 200
},
"created_date": "2013-06-19T11:36:43.000-04:00",
"modified_date": "2013-08-23T12:54:17.000-04:00",
"folder_id": null,
"is_image": true,
"file_type": "JPG"
}