Trendsic Platform Service

<back to all web services

CRMimageRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/CRMimage/{ContactId}
CRMimageRequest Parameters:
NameParameterData TypeRequiredDescription
DocumentbodyList<Document>No
ContactIdpathintNo
FieldsbodyDictionary<string, string>No
Document Parameters:
NameParameterData TypeRequiredDescription
DocumentIdformGuidNo
DocTypeformstringNo
DocCategoryformstringNo
DocSubCategoryformstringNo
DocTitleformstringNo
DocDescriptionformstringNo
DocDataformbyte[]No
DocExpirationformDateTime?No
DocMimeTypeformstringNo
DisplayOrderformintNo
FileSizeInKBformdoubleNo
LinkformstringNo
UploadDateformDateTime?No
DocKeyformstringNo
DocumentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DocumentformList<Document>No

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/CRMimage/{ContactId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}],"ContactId":0,"Fields":{"String":"String"}}
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"}},"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}]}