Trendsic Platform Service

<back to all web services

FormSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/settings
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class FormReadinessCheck
            Public Overridable Property Level As String
            Public Overridable Property Text As String
            Public Overridable Property FixTab As String
            Public Overridable Property FixFieldKey As String
            Public Overridable Property FixLabel As String
        End Class

        Public Partial Class FormSettingsRequest
            Public Overridable Property FormUID As Guid
        End Class

        Public Partial Class FormSettingsResponse
            Public Overridable Property SettingsJson As String
            Public Overridable Property SettingsRev As Integer
            Public Overridable Property Link As String
            Public Overridable Property LinkPaused As String
            Public Overridable Property OfferChecks As List(Of FormReadinessCheck) = New List(Of FormReadinessCheck)
            Public Overridable Property DraftsInProgress As Integer
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

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

GET /v1/forms/{FormUID}/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SettingsJson":"String","SettingsRev":0,"Link":"String","LinkPaused":"String","OfferChecks":[{"Level":"String","Text":"String","FixTab":"String","FixFieldKey":"String","FixLabel":"String"}],"DraftsInProgress":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}