Field Squared API Services

<back to all web services

DocumentTemplate

Represents a single document template
.

The following routes are available for this service:
GET,POST,DELETE/{Workspace}/DocumentTemplate/{Type}
GET/{Workspace}/DocumentTemplate
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Workspaces

Namespace Global

    Namespace Field2Office.API.Model.Workspaces

        '''<Summary>
        '''Represents a single document template.
        '''</Summary>
        Public Partial Class DocumentTemplate
            Public Sub New()
                Data = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Type As String
            Public Overridable Property Data As Dictionary(Of String, Object)
        End Class
    End Namespace
End Namespace

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

<DocumentTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>value</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">String</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
  </Data>
  <Type>String</Type>
  <Workspace>String</Workspace>
  <_data>String</_data>
</DocumentTemplate>