很抱歉,本页面中文版尚未完成,正在由Emarsys本地化团队努力筹备中。
Returns a list of the available folders in the Media Database.
Endpoint
GET https://api.emarsys.net/api/v2/folder
Parameters
Name | Type | Description | Comments |
---|---|---|---|
folder | int | ID of an existing folder in the Media Database | If <folder> is provided then any subfolders are returned as part of the URI. |
URI Example
To query all folders: /api/v2/folder
To query subfolders of a specific folder: /api/v2/folder/?folder=12
Result Example
{ "replyCode": 0, "replyText": "OK", "data": [ { "id": "123", "parent": "1", "name": "heroes" }, { "id": "456", "parent": "1", "name": "humans" } ] }
Where
- parent is the parent folder. If a parent folder is specified, only its subfolders are returned.
Errors
HTTP Code | Reply Code | Message | Description |
---|---|---|---|
400 | 10001 | Folder does not exist: [folder] | The folder parameter in the request is invalid or a folder with this ID does not exist in the Media Database. |
400 | 10001 | Invalid filter: [filter] | The filter is invalid. Currently only folder is supported. |
400 | 10001 | Invalid value for [filter] filter: [value] | The value is invalid for the given filter. The folder filter accepts integers only. |