Antel Merchandiser App API

<back to all web services

GetImage

The following routes are available for this service:
GET/imageReturns the specified image based on the Id.
GET/image/{id}Returns the specified image based on the Id.
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetImage
{
    @ApiMember(DataType="int", IsRequired=true)
    var Id:UUID? = null

    /**
    * Manually control the server resizing of the image.
    */
    @ApiMember(Description="Manually control the server resizing of the image.")
    var ImageSize:ImageSize? = null

    /**
    * Set to true to return the image in Base64 format.
    */
    @ApiMember(DataType="boolean", Description="Set to true to return the image in Base64 format.")
    var Base64:Boolean? = null

    @ApiMember()
    var Platform:String? = null

    /**
    * Force this file to be returned as a thumbnail (small)
    */
    @ApiMember(Description="Force this file to be returned as a thumbnail (small)")
    var Thumbnail:Boolean? = null
}

enum class ImageSize(val value:Int)
{
    @SerializedName("0") Unknown(0),
    @SerializedName("1") Full(1),
    @SerializedName("2") Small(2),
    @SerializedName("3") Medium(3),
    @SerializedName("4") Large(4),
    @SerializedName("5") XLarge(5),
}

Kotlin GetImage 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 /image HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/xml