BusinessApi

UploadAdMessageImageRequest

Business

**Requires Authentication**
Required role:	Business

The following routes are available for this service:
POST	/admessage/upload_image_to_library

<?php namespace BusinessApi;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum DeploymentSlot : string
{
    case Production = 'Production';
    case Qa = 'Qa';
    case Unstable = 'Unstable';
    case Test = 'Test';
    case Local = 'Local';
    case Docker = 'Docker';
}

class CloudBlob implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $publicUrl='',
        /** @var string */
        public string $key='',
        /** @var DeploymentSlot|null */
        public ?DeploymentSlot $environment=null,
        /** @var string */
        public string $bucket='',
        /** @var string */
        public string $identifyingSuffix='',
        /** @var string */
        public string $mimeType=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['publicUrl'])) $this->publicUrl = $o['publicUrl'];
        if (isset($o['key'])) $this->key = $o['key'];
        if (isset($o['environment'])) $this->environment = JsonConverters::from('DeploymentSlot', $o['environment']);
        if (isset($o['bucket'])) $this->bucket = $o['bucket'];
        if (isset($o['identifyingSuffix'])) $this->identifyingSuffix = $o['identifyingSuffix'];
        if (isset($o['mimeType'])) $this->mimeType = $o['mimeType'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->publicUrl)) $o['publicUrl'] = $this->publicUrl;
        if (isset($this->key)) $o['key'] = $this->key;
        if (isset($this->environment)) $o['environment'] = JsonConverters::to('DeploymentSlot', $this->environment);
        if (isset($this->bucket)) $o['bucket'] = $this->bucket;
        if (isset($this->identifyingSuffix)) $o['identifyingSuffix'] = $this->identifyingSuffix;
        if (isset($this->mimeType)) $o['mimeType'] = $this->mimeType;
        return empty($o) ? new class(){} : $o;
    }
}

class ImageUrls implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $preview='',
        /** @var string */
        public string $small='',
        /** @var string */
        public string $medium='',
        /** @var string */
        public string $large=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['preview'])) $this->preview = $o['preview'];
        if (isset($o['small'])) $this->small = $o['small'];
        if (isset($o['medium'])) $this->medium = $o['medium'];
        if (isset($o['large'])) $this->large = $o['large'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->preview)) $o['preview'] = $this->preview;
        if (isset($this->small)) $o['small'] = $this->small;
        if (isset($this->medium)) $o['medium'] = $this->medium;
        if (isset($this->large)) $o['large'] = $this->large;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>