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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class BusinessApi
{

    public static class CloudBlob
    {
        public String publicUrl = null;
        public String key = null;
        public DeploymentSlot environment = null;
        public String bucket = null;
        public String identifyingSuffix = null;
        public String mimeType = null;
        
        public String getPublicUrl() { return publicUrl; }
        public CloudBlob setPublicUrl(String value) { this.publicUrl = value; return this; }
        public String getKey() { return key; }
        public CloudBlob setKey(String value) { this.key = value; return this; }
        public DeploymentSlot getEnvironment() { return environment; }
        public CloudBlob setEnvironment(DeploymentSlot value) { this.environment = value; return this; }
        public String getBucket() { return bucket; }
        public CloudBlob setBucket(String value) { this.bucket = value; return this; }
        public String getIdentifyingSuffix() { return identifyingSuffix; }
        public CloudBlob setIdentifyingSuffix(String value) { this.identifyingSuffix = value; return this; }
        public String getMimeType() { return mimeType; }
        public CloudBlob setMimeType(String value) { this.mimeType = value; return this; }
    }

    public static enum DeploymentSlot
    {
        Production,
        Qa,
        Unstable,
        Test,
        Local,
        Docker;
    }

    public static class ImageUrls
    {
        public String preview = null;
        public String small = null;
        public String medium = null;
        public String large = null;
        
        public String getPreview() { return preview; }
        public ImageUrls setPreview(String value) { this.preview = value; return this; }
        public String getSmall() { return small; }
        public ImageUrls setSmall(String value) { this.small = value; return this; }
        public String getMedium() { return medium; }
        public ImageUrls setMedium(String value) { this.medium = value; return this; }
        public String getLarge() { return large; }
        public ImageUrls setLarge(String value) { this.large = value; return this; }
    }

}

Java 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
	}
}