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
"use strict";
/** @typedef {'Production'|'Qa'|'Unstable'|'Test'|'Local'|'Docker'} */
export var DeploymentSlot;
(function (DeploymentSlot) {
    DeploymentSlot["Production"] = "Production"
    DeploymentSlot["Qa"] = "Qa"
    DeploymentSlot["Unstable"] = "Unstable"
    DeploymentSlot["Test"] = "Test"
    DeploymentSlot["Local"] = "Local"
    DeploymentSlot["Docker"] = "Docker"
})(DeploymentSlot || (DeploymentSlot = {}));
export class CloudBlob {
    /** @param {{publicUrl?:string,key?:string,environment?:DeploymentSlot,bucket?:string,identifyingSuffix?:string,mimeType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    publicUrl;
    /** @type {string} */
    key;
    /** @type {?DeploymentSlot} */
    environment;
    /** @type {string} */
    bucket;
    /** @type {string} */
    identifyingSuffix;
    /** @type {string} */
    mimeType;
}
export class ImageUrls {
    /** @param {{preview?:string,small?:string,medium?:string,large?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    preview;
    /** @type {string} */
    small;
    /** @type {string} */
    medium;
    /** @type {string} */
    large;
}

JavaScript GetAdMessageImagesRequest DTOs

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
		}
	]
}