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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PlaceUploadImageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Base64EncodedImageFront>String</Base64EncodedImageFront>
  <PlaceId>0</PlaceId>
</PlaceUploadImageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PlaceUploadImageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Image xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:Bucket>String</d2p1:Bucket>
    <d2p1:Environment>Production</d2p1:Environment>
    <d2p1:IdentifyingSuffix>String</d2p1:IdentifyingSuffix>
    <d2p1:Key>String</d2p1:Key>
    <d2p1:MimeType>String</d2p1:MimeType>
    <d2p1:PublicUrl>String</d2p1:PublicUrl>
  </Image>
  <ImageUrls xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:Large>String</d2p1:Large>
    <d2p1:Medium>String</d2p1:Medium>
    <d2p1:Preview>String</d2p1:Preview>
    <d2p1:Small>String</d2p1:Small>
  </ImageUrls>
</PlaceUploadImageResponse>