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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Images;

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 ImageList()
        {
            ImageIds = new List<string>{};
        }

        public virtual string Workspace { get; set; }
        public virtual List<string> ImageIds { get; set; }
        public virtual string DocumentId { get; set; }
    }

}

C# 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"}