BusinessApi

<back to all web services

GetAdMessageImagesRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/admessage/get_image_library
GetAdMessageImagesRequest Parameters:
NameParameterData TypeRequiredDescription
AdMessageIdquerylongNo
GetAdMessageImagesResponse Parameters:
NameParameterData TypeRequiredDescription
AdMessageImagesformList<AdMessageImageDto>Yes
AdMessageImageDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AdMessageIdformlongNo
ImageformCloudBlobYes
ImageUrlsformImageUrlsYes
PositionformintNo
CloudBlob Parameters:
NameParameterData TypeRequiredDescription
PublicUrlformstringYes
KeyformstringYes
EnvironmentformDeploymentSlot?No
BucketformstringYes
IdentifyingSuffixformstringYes
MimeTypeformstringYes
DeploymentSlot Enum:
Production
Qa
Unstable
Test
Local
Docker
ImageUrls Parameters:
NameParameterData TypeRequiredDescription
PreviewformstringYes
SmallformstringYes
MediumformstringYes
LargeformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /admessage/get_image_library HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	adMessageImages: 
	[
		{
			id: 0,
			adMessageId: 0,
			image: 
			{
				publicUrl: String,
				key: String,
				environment: Production,
				bucket: String,
				identifyingSuffix: String,
				mimeType: String
			},
			imageUrls: 
			{
				preview: String,
				small: String,
				medium: String,
				large: String
			},
			position: 0
		}
	]
}