Antel 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 Foundation
import ServiceStack

public class GetImage : Codable
{
    // @ApiMember(DataType="int", IsRequired=true)
    public var id:Int

    /**
    * Manually control the server resizing of the image.
    */
    // @ApiMember(Description="Manually control the server resizing of the image.")
    public var imageSize:SizeType

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

    // @ApiMember()
    public var platform:String

    /**
    * Force this file to be returned as a thumbnail (small)
    */
    // @ApiMember(Description="Force this file to be returned as a thumbnail (small)")
    public var thumbnail:Bool

    required public init(){}
}

public enum SizeType : Int, Codable
{
    case Unknown = 0
    case Full = 1
    case Small = 2
    case Medium = 3
    case Large = 4
    case XLarge = 5
}


Swift 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: antel.api.dev.86degrees.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />