Field Squared API 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}

import Foundation
import ServiceStack

/**
* 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}.
*/
public class Image : Codable
{
    public var workspace:String
    public var objectId:String

    required public init(){}
}

Swift Image 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.

POST /{Workspace}/Image/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Image xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
  <ObjectId>String</ObjectId>
  <Workspace>String</Workspace>
</Image>