BusinessApi

<back to all web services

UploadAdMessageImageRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/admessage/upload_image_to_library

export module BusinessApi
{
    // @ts-nocheck

    export enum DeploymentSlot
    {
        Production = 'Production',
        Qa = 'Qa',
        Unstable = 'Unstable',
        Test = 'Test',
        Local = 'Local',
        Docker = 'Docker',
    }

    export class CloudBlob
    {
        public publicUrl: string;
        public key: string;
        public environment?: DeploymentSlot;
        public bucket: string;
        public identifyingSuffix: string;
        public mimeType: string;

        public constructor(init?: Partial<CloudBlob>) { (Object as any).assign(this, init); }
    }

    export class ImageUrls
    {
        public preview: string;
        public small: string;
        public medium: string;
        public large: string;

        public constructor(init?: Partial<ImageUrls>) { (Object as any).assign(this, init); }
    }

}

TypeScript UploadAdMessageImageRequest 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.

POST /admessage/upload_image_to_library HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	adMessageId: 0,
	base64EncodedImage: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	adMessageImage: 
	{
		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
	}
}