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
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 UploadAdMessageImageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	adMessageId: 0,
	base64EncodedImage: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	adMessageImage: 
	{
		id: 0,
		adMessageId: 0,
		image: 
		{
			publicUrl: String,
			key: String,
			environment: Production,
			bucket: String,
			identifyingSuffix: String,
			mimeType: String
		},
		imageUrls: 
		{
			preview: String,
			small: String,
			medium: String,
			large: String
		},
		position: 0
	}
}