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


/** @description Service representing an image list request in a workspace. Returns a .ZIP file containing all the images in the request. */
export class ImageList
{
    public Workspace: string;
    public ImageIds: string[];
    public DocumentId: string;

    public constructor(init?: Partial<ImageList>) { (Object as any).assign(this, init); }
}

TypeScript ImageList 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}/ImageList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ImageList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Images">
  <DocumentId>String</DocumentId>
  <ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ImageIds>
  <Workspace>String</Workspace>
</ImageList>