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
"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 UploadAdMessageImageRequest 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 /admessage/upload_image_to_library HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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