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

library BusinessApi;
import 'package:servicestack/servicestack.dart';

enum DeploymentSlot
{
    Production,
    Qa,
    Unstable,
    Test,
    Local,
    Docker,
}

class CloudBlob implements IConvertible
{
    String? publicUrl;
    String? key;
    DeploymentSlot? environment;
    String? bucket;
    String? identifyingSuffix;
    String? mimeType;

    CloudBlob({this.publicUrl,this.key,this.environment,this.bucket,this.identifyingSuffix,this.mimeType});
    CloudBlob.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        publicUrl = json['publicUrl'];
        key = json['key'];
        environment = JsonConverters.fromJson(json['environment'],'DeploymentSlot',context!);
        bucket = json['bucket'];
        identifyingSuffix = json['identifyingSuffix'];
        mimeType = json['mimeType'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'publicUrl': publicUrl,
        'key': key,
        'environment': JsonConverters.toJson(environment,'DeploymentSlot',context!),
        'bucket': bucket,
        'identifyingSuffix': identifyingSuffix,
        'mimeType': mimeType
    };

    getTypeName() => "CloudBlob";
    TypeContext? context = _ctx;
}

class ImageUrls implements IConvertible
{
    String? preview;
    String? small;
    String? medium;
    String? large;

    ImageUrls({this.preview,this.small,this.medium,this.large});
    ImageUrls.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        preview = json['preview'];
        small = json['small'];
        medium = json['medium'];
        large = json['large'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'preview': preview,
        'small': small,
        'medium': medium,
        'large': large
    };

    getTypeName() => "ImageUrls";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'BusinessApi', types: <String, TypeInfo> {
    'DeploymentSlot': TypeInfo(TypeOf.Enum, enumValues:DeploymentSlot.values),
    'CloudBlob': TypeInfo(TypeOf.Class, create:() => CloudBlob()),
    'ImageUrls': TypeInfo(TypeOf.Class, create:() => ImageUrls()),
});

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