Field Squared API Services

<back to all web services

ImageList

Service representing an image list request in a workspace.
Returns a .ZIP file containing all the images in the request.

The following routes are available for this service:
POST/{Workspace}/ImageList
GET/{Workspace}/ImageList/{DocumentId}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Images

Namespace Global

    Namespace Field2Office.API.Model.Images

        '''<Summary>
        '''Service representing an image list request in a workspace. Returns a .ZIP file containing all the images in the request.
        '''</Summary>
        Public Partial Class ImageList
            Public Sub New()
                ImageIds = New List(Of String)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property ImageIds As List(Of String)
            Public Overridable Property DocumentId As String
        End Class
    End Namespace
End Namespace

VB.NET ImageList 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.

POST /{Workspace}/ImageList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","ImageIds":["String"],"DocumentId":"String"}