getBrochureDetail

Returns the details for a 'single' Brochure (asset). Typically used for deep-linking.

Request

GET /rest/brochures/{brochureId}

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Parameters

Parameter	Type	Required	Description
brochureId		Yes	Id of asset being requested
deviceType		Yes	Device type. Defaults to IPAD.
appCode		Yes	App code. Defaults to NI.

Response

200 OK

{
  "userId": 8,
  "bId": 3,
  "bName": "MY Brochure 1 (iPad & Desktop)",
  "cId": 3,
  "pId": 3,
  "pName": "MI Company 3 Product",
  "bStatus": "A",
  "bIsInternal": "N",
  "bvId": 5,
  "bvDesc": "Brochure 3, Version 1",
  "bvAsset": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/brochures/5/asset3-v1.zip",
  "bvAssetMD5": "MD5-HASH#1",
  "bvBytes": 14300,
  "bvStatus": "A",
  "bBody": "Body for Brochure 3, Version 1",
  "bImage": "http://dev-sam-images.interact.technology/3/brochureimages/LOGO.jpg",
  "bFormat": "pdf",
  "bModified": 1508098597000,
  "bCreated": 1508098597000,
    "globalId": 7777,
    "htmlAssetRedirectUrl": "http://test.redirect.com/url",
    "bAutoDownload": "Y",
    "bvAutoFillCredentials": "Y",
    "bPushNotificationDefault": "Opt in",
    "bEmailNotificationDefault": "Opt out",
    "bNotifyUserOfExternalUrl": "Y"
}

Response Fields

Field	Type	Required	Description
globalId	Integer	No	Defines the SSO global Id indicating that the asset is an SSO URL Asset.
htmlAssetRedirectUrl	String(1024)	No	Contains the URL embedded within URL redirect assets. Needed for SSO due to limitations of webview cookies and redirects.
bPushNotificationDefault	String(7)	No	Value of either "Opt in" or "Opt out" indicating the default for push notifications.
bEmailNotificationDefault	String(7)	No	Value of either "Opt in" or "Opt out" indicating the default for email notifications.

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSInsufficientPrivilegesException	See Error Definitions
WSBrochureNotFoundException	See Error Definitions
WSBrochureServiceException	See Error Definitions