Field Squared API Services

<back to all web services

StringData

An object used to capture generic string data and version it

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/StringData/{Class}/{Type}
GET/{Workspace}/StringData/{Class}
GET/{Workspace}/StringData/VersionHistory/{Class}/{Type}
GET/{Workspace}/CatalogNames
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Data

Namespace Global

    Namespace Field2Office.API.Model.Data

        '''<Summary>
        '''An object used to capture generic string data and version it
        '''</Summary>
        Public Partial Class StringData
            Public Sub New()
                Data = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property VersionId As String
            Public Overridable Property BasedOn As String
            Public Overridable Property [Class] 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 StringData DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Workspace}/StringData/{Class}/{Type} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","VersionId":"String","BasedOn":"String","Class":"String","Type":"String","Data":{"value":"String"}}