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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Documents

Namespace Global

    Namespace Field2Office.API.Model.Documents

        '''<Summary>
        '''Returns a set of documents based on a set of domain items
        '''</Summary>
        Public Partial Class DocumentBatch
            Public Sub New()
                Items = New List(Of Object)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Items As List(Of Object)
            Public Overridable Property OwnerSchemaData As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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>