Individual MyLibrary Folder
Use this endpoint to retrieve (GET), update (PUT), or DELETE an existing MyLibrary folder.
Methods:
Click a method to view its documentation
DescriptionTOP
Privileges required: mylibrary:folder:read
Retrieve a specific MyLibrary folder using the folderId path parameter.
|
GET: https://api.constantcontact.com/v2/library/folders/{folderId} |
|||
name |
type |
default |
description |
|---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
folderId |
path |
Specifies the MyLibary folder to retrieve |
|
Response CodesTOP
code |
description |
|---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
The specified folder ID does not exist |
406 |
Unsupported accept header value, must be application/json |
500 |
Internal server error occurred |
StructureTOP
|
property |
type(max length) |
description |
|||
|---|---|---|---|---|---|
|
+ children |
array |
List of child or grandchild folders within the selected folder, MyLibrary support 3 levels of folder nesting |
|||
|
|||||
|
created_date |
string |
Date the folder was created, in ISO-8601 format |
|||
|
id |
string |
Unique ID of the library folder |
|||
|
item_count |
integer |
Number of files in the library folder |
|||
|
level |
integer |
Indicates which level the folder resides at:
|
|||
|
modified_date |
string |
Date the folder was last updated, in ISO-8601 format |
|||
|
name |
string (40) |
Name of the library folder, supports only ISO-8859-1 characters (no support for UTF-8 enoding) |
|||
|
parent_id |
string |
Unique ID of the current folder's parent folder; if the folder is at the top level (not nested), value is null |
|||
Example ResponseTOP
{
"id":"-4",
"name":"Documents",
"level":1,
"children":[{
"id":"-10",
"name":"market_studies",
"level":2,
"children":[],
"item_count":0,
"parent_id":"-4",
"modified_date":"2013-06-24T13:12:10.000-04:00",
"created_date":"2013-06-05T09:31:55.000-04:00"
}],
"item_count":1,
"parent_id":"0",
"modified_date":"2013-06-24T13:12:10.000-04:00",
"created_date":"2013-06-05T09:31:55.000-04:00"
}