Trendsic Platform Service

<back to all web services

FormFillReplyRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/request/send
FormFillReplyRequest Parameters:
NameParameterData TypeRequiredDescription
TokenpathstringNo
RequestUIDbodystringNo
AnswersJsonbodystringNo
LangbodystringNo
FormFillReplyResponse Parameters:
NameParameterData TypeRequiredDescription
SentformboolNo
StatusformFormFillStatusResponseNo
ErrorsformList<FormFillFieldError>No
ResponseStatusformResponseStatusNo
FormFillStatusResponse Parameters:
NameParameterData TypeRequiredDescription
NumberformstringNo
FormNameformstringNo
NounformstringNo
TenantNameformstringNo
StageformstringNo
StageKindformstringNo
StagesformList<FormFillStage>No
SeenformList<FormFillStageSeen>No
SubmittedAtformDateTime?No
ReceiptformList<FormFillReceiptLine>No
CanWithdrawformboolNo
LangformstringNo
NounEsformstringNo
HasRequestformboolNo
RequestNoteformstringNo
OutcomeformstringNo
DecisionReasonformstringNo
DecisionNoteformstringNo
ResponseStatusformResponseStatusNo
FormFillStage Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LabelformstringNo
ToneformstringNo
KindformstringNo
FormFillStageSeen Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
AtformDateTimeNo
FormFillReceiptLine Parameters:
NameParameterData TypeRequiredDescription
ChannelformstringNo
ToformstringNo
OutcomeformstringNo
FormFillFieldError Parameters:
NameParameterData TypeRequiredDescription
KformstringNo
MsgformstringNo

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 /v1/formfill/status/{Token}/request/send HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Token":"String","RequestUID":"String","AnswersJson":"String","Lang":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Sent":false,"Status":{"Number":"String","FormName":"String","Noun":"String","TenantName":"String","Stage":"String","StageKind":"String","Stages":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"Seen":[{"Id":"String","At":"0001-01-01T00:00:00.0000000"}],"SubmittedAt":"0001-01-01T00:00:00.0000000","Receipt":[{"Channel":"String","To":"String","Outcome":"String"}],"CanWithdraw":false,"Lang":"String","NounEs":"String","HasRequest":false,"RequestNote":"String","Outcome":"String","DecisionReason":"String","DecisionNote":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}},"Errors":[{"K":"String","Msg":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}