Field Squared API Services

<back to all web services

Image

Service representing an Image in a workspace. Note that it's
not necessary to include the Workspace and ObjectId in the POST request body
despite what the auto generated documentation says. These values are taken from
the endpoint itself. Also, during GET, the Accept Type in the request needs to be
populated and needs to match the existing content type stored against the image.
To GET a resized image, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.
To resize an image during POST, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.

The following routes are available for this service:
GET,POST,DELETE/{Workspace}/Image/{ObjectId}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Workspaces

Namespace Global

    Namespace Field2Office.API.Model.Workspaces

        '''<Summary>
        '''Service representing an Image in a workspace.  Note that it's not necessary to include the Workspace and ObjectId in the POST request body despite what the auto generated documentation says.  These values are taken from the endpoint itself.  Also, during GET, the Accept Type in the request needs to be populated and needs to match the existing content type stored against the image. To GET a resized image, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.To resize an image during POST, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.
        '''</Summary>
        Public Partial Class Image
            Public Overridable Property Workspace As String
            Public Overridable Property ObjectId As String
        End Class
    End Namespace
End Namespace

VB.NET Image 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}/Image/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","ObjectId":"String"}