Trendsic Platform Service

<back to all web services

FormNoticePreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/notices/preview
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 FormInboxCount
            Public Overridable Property V As String
            Public Overridable Property L As String
            Public Overridable Property N As Integer
        End Class

        Public Partial Class FormNoticePreviewRequest
            Public Overridable Property FormUID As Guid
            Public Overridable Property Id As String
            Public Overridable Property Lang As String
            Public Overridable Property Channel As String
            Public Overridable Property Subject As String
            Public Overridable Property Body As String
            Public Overridable Property Text As String
            Public Overridable Property Closing As String
            Public Overridable Property SubmissionUID As Guid?
        End Class

        Public Partial Class FormNoticePreviewResponse
            Public Overridable Property Subject As String
            Public Overridable Property Body As String
            Public Overridable Property Meta As String
            Public Overridable Property SubmissionUID As String
            Public Overridable Property Sample As Boolean
            Public Overridable Property SampleNote As String
            Public Overridable Property TextLength As Integer
            Public Overridable Property Segments As Integer
            Public Overridable Property Wide As Boolean
            Public Overridable Property Problems As List(Of String) = New List(Of String)
            Public Overridable Property Samples As List(Of FormInboxCount) = New List(Of FormInboxCount)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET FormNoticePreviewRequest 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 /v1/forms/{FormUID}/notices/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FormUID":"00000000000000000000000000000000","Id":"String","Lang":"String","Channel":"String","Subject":"String","Body":"String","Text":"String","Closing":"String","SubmissionUID":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Subject":"String","Body":"String","Meta":"String","SubmissionUID":"String","Sample":false,"SampleNote":"String","TextLength":0,"Segments":0,"Wide":false,"Problems":["String"],"Samples":[{"V":"String","L":"String","N":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}