Trendsic Platform Service

<back to all web services

DocumentShareCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/documentshare
DocumentShareCreateRequest Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdbodyGuidNo
RecipientContactIdbodyintNo
RecipientEmailbodystringNo
RecipientPhonebodystringNo
IsAdhocbodyboolNo
SensitivityTierbodystringNo
RequireOtpbodyboolNo
OtpChannelbodystringNo
DeliveryChannelsbodystringNo
ExpiresInHoursbodyintNo
MaxViewsbodyintNo
DocumentShareResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DocumentShareformList<DocumentShareExtended>No
ShareUrlformstringNo
DocumentShareExtended Parameters:
NameParameterData TypeRequiredDescription
AttachmentNameformstringNo
RecipientDisplayNameformstringNo
RecipientTypeformstringNo
CreatedByNameformstringNo
StatusformstringNo
DocumentShare Parameters:
NameParameterData TypeRequiredDescription
DocumentShareIdformintNo
DocumentShareUIDformGuidNo
TokenHashformstringNo
AttachmentIdformGuidNo
SensitivityTierformstringNo
RequireOtpformboolNo
OtpChannelformstringNo
DeliveryChannelsformstringNo
RecipientContactIdformint?No
RecipientEmailformstringNo
RecipientPhoneformstringNo
SmsConsentSnapshotformboolNo
CreatedByUserIdformGuidNo
CreatedByAgentIdformint?No
CreatedAtUtcformDateTimeNo
ExpiresAtUtcformDateTimeNo
MaxViewsformint?No
ViewCountformintNo
RevokedAtUtcformDateTime?No
RevokedByUserIdformGuid?No

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/documentshare HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AttachmentId":"00000000000000000000000000000000","RecipientContactId":0,"RecipientEmail":"String","RecipientPhone":"String","IsAdhoc":false,"SensitivityTier":"String","RequireOtp":false,"OtpChannel":"String","DeliveryChannels":"String","ExpiresInHours":0,"MaxViews":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"DocumentShare":[{"AttachmentName":"String","RecipientDisplayName":"String","RecipientType":"String","CreatedByName":"String","Status":"String","DocumentShareId":0,"DocumentShareUID":"00000000000000000000000000000000","TokenHash":"String","AttachmentId":"00000000000000000000000000000000","SensitivityTier":"String","RequireOtp":false,"OtpChannel":"String","DeliveryChannels":"String","RecipientContactId":0,"RecipientEmail":"String","RecipientPhone":"String","SmsConsentSnapshot":false,"CreatedByUserId":"00000000000000000000000000000000","CreatedByAgentId":0,"CreatedAtUtc":"0001-01-01T00:00:00.0000000","ExpiresAtUtc":"0001-01-01T00:00:00.0000000","MaxViews":0,"ViewCount":0,"RevokedAtUtc":"0001-01-01T00:00:00.0000000","RevokedByUserId":"00000000000000000000000000000000"}],"ShareUrl":"String"}