BusinessApi

<back to all web services

GetAdMessageImagesRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/admessage/get_image_library
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module BusinessApi


class DeploymentSlot(str, Enum):
    PRODUCTION = 'Production'
    QA = 'Qa'
    UNSTABLE = 'Unstable'
    TEST = 'Test'
    LOCAL = 'Local'
    DOCKER = 'Docker'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloudBlob:
    public_url: Optional[str] = None
    key: Optional[str] = None
    environment: Optional[DeploymentSlot] = None
    bucket: Optional[str] = None
    identifying_suffix: Optional[str] = None
    mime_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImageUrls:
    preview: Optional[str] = None
    small: Optional[str] = None
    medium: Optional[str] = None
    large: Optional[str] = None


Python GetAdMessageImagesRequest 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.

GET /admessage/get_image_library HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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