BusinessApi

<back to all web services

PlaceUploadImageRequest

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

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 PlaceUploadImageRequest 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 /place/upload_image HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	image: 
	{
		publicUrl: String,
		key: String,
		environment: Production,
		bucket: String,
		identifyingSuffix: String,
		mimeType: String
	},
	imageUrls: 
	{
		preview: String,
		small: String,
		medium: String,
		large: String
	}
}