Appearance
getFoldersAndBrochuresForUser ​
Retrieves a list of folders and the brochures for those folders that have been assigned by the CMS for that user
Request ​
http
GET /rest/brochures/foldersHeaders ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
| Parameter | Type | Required | Description |
|---|---|---|---|
cId | No | CompanyId (OPTIONAL for Next Interact, MANDATORY for My Interact) | |
deviceType | Yes | Either "iPad" or "iPhone". If not passed, defaults to "iPad". | |
appCode | Yes | Either "NI" or "MY". If not passed, defaults to "NI". | |
includePrivate | boolean | No | Flag (true/false) to indicate whether SAM should include both public and private folders. Defaults to Public when not provided. |
Response ​
200 OK ​
json
[
{ "brochures" : [ 1 ],
"colour" : "57,0,0",
"fId" : 1,
"folderName" : "Team 1 Folder 1",
"folderOrder" : 1,
"libraryType" : "Public",
"teamId" : 1,
"teamName" : "Team 1"
},
{ "brochures" : [ 1 ],
"colour" : "0,215,0",
"fId" : 2,
"folderName" : "Team 2 Folder 1",
"folderOrder" : 2,
"libraryType" : "Public",
"teamId" : 2,
"teamName" : "Team 2"
},
{ "brochures" : [ 2 ],
"colour" : "0,0,117",
"fId" : 3,
"folderName" : "My Private Folder",
"folderOrder" : 3,
"libraryType" : "Private",
"teamId" : 2,
"teamName" : "Team 2"
}
]Errors ​
| Exception | Description |
|---|---|
WSUserServiceUnavailableException | See Error Definitions |
WSBrochureServiceUnavailableException | See Error Definitions |
WSInvalidAuthTokenException | See Error Definitions |
WSInvalidParameterException | See Error Definitions |
WSInsufficientPermissionsException | See Error Definitions |
WSBrochureServiceException | See Error Definitions |
WSCacheServiceException | See Error Definitions |