Field Squared API Services

<back to all web 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

/** @description Returns a set of documents based on a set of domain items */
export class DocumentBatch
{
    public Workspace: string;
    public Items: Object[];
    public OwnerSchemaData: boolean;

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

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