Trendsic Platform Service

<back to all web services

RequestLetterRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/requests/{RequestId}/letter
RequestLetterRequest Parameters:
NameParameterData TypeRequiredDescription
RequestIdpathintNo
RequestLetterResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LetterKeyformstringNo
FiledformboolNo

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.

GET /v1/records/requests/{RequestId}/letter HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"LetterKey":"String","Filed":false}