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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormInboxCount() = 
        member val V:String = null with get,set
        member val L:String = null with get,set
        member val N:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FormNoticePreviewResponse() = 
        member val Subject:String = null with get,set
        member val Body:String = null with get,set
        member val Meta:String = null with get,set
        member val SubmissionUID:String = null with get,set
        member val Sample:Boolean = new Boolean() with get,set
        member val SampleNote:String = null with get,set
        member val TextLength:Int32 = new Int32() with get,set
        member val Segments:Int32 = new Int32() with get,set
        member val Wide:Boolean = new Boolean() with get,set
        member val Problems:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Samples:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormNoticePreviewRequest() = 
        member val FormUID:Guid = new Guid() with get,set
        member val Id:String = null with get,set
        member val Lang:String = null with get,set
        member val Channel:String = null with get,set
        member val Subject:String = null with get,set
        member val Body:String = null with get,set
        member val Text:String = null with get,set
        member val Closing:String = null with get,set
        member val SubmissionUID:Nullable<Guid> = new Nullable<Guid>() with get,set

F# FormNoticePreviewRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}