Field Squared API Services

<back to all web services

DocumentUpload

Bulk upload a file for later import..

The following routes are available for this service:
POST/{Workspace}/DocumentUpload
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>
        '''Bulk upload a file for later import..
        '''</Summary>
        Public Partial Class DocumentUpload
            Public Sub New()
                Columns = New List(Of String)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Id As String
            Public Overridable Property Columns As List(Of String)
            Public Overridable Property RowCount As Integer
            Public Overridable Property Delimiter As String
        End Class
    End Namespace
End Namespace

VB.NET DocumentUpload DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/DocumentUpload HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","Id":"String","Columns":["String"],"RowCount":0,"Delimiter":"String"}