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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.AppApi.Models.ResourceModels
Imports CommonService.Media

Namespace Global

    Namespace CommonService.Media

        Public Enum ImageSize
            Unknown = 0
            Full = 1
            Small = 2
            Medium = 3
            Large = 4
            XLarge = 5
        End Enum
    End Namespace

    Namespace WebService.AppApi.Models.ResourceModels

        Public Partial Class GetImage
            <ApiMember(DataType:="int", IsRequired:=true)>
            Public Overridable Property Id As Guid

            '''<Summary>
            '''Manually control the server resizing of the image.
            '''</Summary>
            <ApiMember(Description:="Manually control the server resizing of the image.")>
            Public Overridable Property ImageSize As ImageSize

            '''<Summary>
            '''Set to true to return the image in Base64 format.
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="Set to true to return the image in Base64 format.")>
            Public Overridable Property Base64 As Boolean

            <ApiMember>
            Public Overridable Property Platform As String

            '''<Summary>
            '''Force this file to be returned as a thumbnail (small)
            '''</Summary>
            <ApiMember(Description:="Force this file to be returned as a thumbnail (small)")>
            Public Overridable Property Thumbnail As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetImage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv