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}

import 'package:servicestack/servicestack.dart';

/**
* Service representing an image list request in a workspace. Returns a .ZIP file containing all the images in the request.
*/
class ImageList implements IConvertible
{
    String? Workspace;
    List<String>? ImageIds;
    String? DocumentId;

    ImageList({this.Workspace,this.ImageIds,this.DocumentId});
    ImageList.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        ImageIds = JsonConverters.fromJson(json['ImageIds'],'List<String>',context!);
        DocumentId = json['DocumentId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'ImageIds': JsonConverters.toJson(ImageIds,'List<String>',context!),
        'DocumentId': DocumentId
    };

    getTypeName() => "ImageList";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'ImageList': TypeInfo(TypeOf.Class, create:() => ImageList()),
});

Dart 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>