BusinessApi

<back to all web services

PlaceUploadLogoRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/place/upload_logo
"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 PlaceUploadLogoRequest 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_logo HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<PlaceUploadLogoResponse 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>
</PlaceUploadLogoResponse>