Skip to content

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/folders

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

ParameterTypeRequiredDescription
cIdNoCompanyId (OPTIONAL for Next Interact, MANDATORY for My Interact)
deviceTypeYesEither "iPad" or "iPhone". If not passed, defaults to "iPad".
appCodeYesEither "NI" or "MY". If not passed, defaults to "NI".
includePrivatebooleanNoFlag (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 ​

ExceptionDescription
WSUserServiceUnavailableExceptionSee Error Definitions
WSBrochureServiceUnavailableExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSInsufficientPermissionsExceptionSee Error Definitions
WSBrochureServiceExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions