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.
"use strict";
/** @typedef {number} */
export var SizeType;
(function (SizeType) {
    SizeType[SizeType["Unknown"] = 0] = "Unknown"
    SizeType[SizeType["Full"] = 1] = "Full"
    SizeType[SizeType["Small"] = 2] = "Small"
    SizeType[SizeType["Medium"] = 3] = "Medium"
    SizeType[SizeType["Large"] = 4] = "Large"
    SizeType[SizeType["XLarge"] = 5] = "XLarge"
})(SizeType || (SizeType = {}));
export class GetImage {
    /** @param {{id?:number,imageSize?:SizeType,base64?:boolean,platform?:string,thumbnail?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /**
     * @type {SizeType}
     * @description Manually control the server resizing of the image. */
    imageSize;
    /**
     * @type {boolean}
     * @description Set to true to return the image in Base64 format. */
    base64;
    /** @type {string} */
    platform;
    /**
     * @type {boolean}
     * @description Force this file to be returned as a thumbnail (small) */
    thumbnail;
}

JavaScript 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/" />