Skip to content

getLatestBrochuresForUser ​

Given a valid auth token, retrieves the list of currently available brochures for that user

Request ​

http
GET /rest/brochures

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

ParameterTypeRequiredDescription
cIdNoCompanyId (OPTIONAL for Next Interact, MANDATORY for My Interact)
deviceTypeNoEither "iPad", "iPhone", "Desktop", "Android Tablet" or "Android Phone". If not passed, defaults to "iPad".
appCodeYesEither "NI" or "MY". If not passed, defaults to "NI".

Response ​

200 OK ​

Array of Brochure Details JSON objects:

json
[
  {
    "cId": 3,
    "bId": 21,
    "userId": 21,
    "pId": 21,
    "pName": "Prod1",
    "bvId": 5,
    "bvAssetMD5": "5b790f2e9f2522d8b20504071ddb809e",
    "bName": "Bro1",
    "bvStatus": "A",
    "bvDesc": "v1",
    "bvAsset": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/brochures/5/PDFMacLandscapeLandscapeV6.zip",
    "bvBytes": 147406,
    "bFormat":"pdf"
    "bIsInternal": "N",
    "bImage": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/brochureimages/21-image.jpg",
    "bHeading": "Heading",
    "bBody": "Body",
    "bStatus": "A",
    "globalId": 7777,
    "htmlAssetRedirectUrl": "http://test.redirect.com/url",
    "bPushNotificationDefault": "Opt in",
    "bEmailNotificationDefault": "Opt out",
    "bNotifyUserOfExternalUrl": "Y"
  },
  {
    "cId": 4,
    "bId": 22,
    "userId": 21,
    "pId": 22,
    "pName": "Insurance1",
    "bvId": 6,
    "bvAssetMD5": "c1785c12c3eb37be0edaff3ad127e4ef",
    "bName": "Ins1",
    "bvStatus": "A",
    "bvDesc": "v2",
    "bvAsset": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/4/brochures/6/PDFMacEmailNoToCV6.zip",
    "bvBytes": 130063,
    "bFormat":"pdf"
    "bIsInternal": "N",
    "bImage": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/4/brochureimages/22-image.jpg",
    "bHeading": "Head",
    "bBody": "Boduy",
    "bStatus": "A",
    "globalId": 7777,
    "htmlAssetRedirectUrl": "http://test.redirect.com/url",
    "bPushNotificationDefault": "Opt in",
    "bEmailNotificationDefault": "Opt out",
    "bNotifyUserOfExternalUrl": "N"
  }
]

NOTE: the above feed is for My Interact. for Next Interact, the feed is like above, but WITHOUT the bImage, bHeading, bBody keys.

Response Fields ​

FieldTypeRequiredDescription
globalIdIntegerNoDefines the SSO global Id indicating that the asset is an SSO URL Asset.
htmlAssetRedirectUrlString(1024)NoContains the URL embedded within URL redirect assets. Needed for SSO due to limitations of webview cookies and redirects.
bPushNotificationDefaultString(7)NoValue of either "Opt in" or "Opt out" indicating the default for push notifications.
bEmailNotificationDefaultString(7)NoValue of either "Opt in" or "Opt out" indicating the default for email notifications.

Errors ​

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