Field Squared API Services

DocumentBatch

Returns a set of documents based on a set of domain items

The following routes are available for this service:
POST	/{Workspace}/DocumentBatch

import 'package:servicestack/servicestack.dart';

/**
* Returns a set of documents based on a set of domain items
*/
class DocumentBatch implements IConvertible
{
    String? Workspace;
    List<dynamic>? Items;
    bool? OwnerSchemaData;

    DocumentBatch({this.Workspace,this.Items,this.OwnerSchemaData});
    DocumentBatch.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

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

<DocumentBatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Documents">
  <Items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
  </Items>
  <OwnerSchemaData>false</OwnerSchemaData>
  <Workspace>String</Workspace>
</DocumentBatch>