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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentBatch:
    """
    Returns a set of documents based on a set of domain items
    """

    workspace: Optional[str] = None
    items: Optional[List[Object]] = None
    owner_schema_data: bool = False

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