Trendsic Platform Service

<back to all web services

DocumentShareListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/documentshare/attachment/{AttachmentId}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DocumentShare
    {
        public virtual int DocumentShareId { get; set; }
        public virtual Guid DocumentShareUID { get; set; }
        public virtual string TokenHash { get; set; }
        public virtual Guid AttachmentId { get; set; }
        public virtual string SensitivityTier { get; set; }
        public virtual bool RequireOtp { get; set; }
        public virtual string OtpChannel { get; set; }
        public virtual string DeliveryChannels { get; set; }
        public virtual int? RecipientContactId { get; set; }
        public virtual string RecipientEmail { get; set; }
        public virtual string RecipientPhone { get; set; }
        public virtual bool SmsConsentSnapshot { get; set; }
        public virtual Guid CreatedByUserId { get; set; }
        public virtual int? CreatedByAgentId { get; set; }
        public virtual DateTime CreatedAtUtc { get; set; }
        public virtual DateTime ExpiresAtUtc { get; set; }
        public virtual int? MaxViews { get; set; }
        public virtual int ViewCount { get; set; }
        public virtual DateTime? RevokedAtUtc { get; set; }
        public virtual Guid? RevokedByUserId { get; set; }
    }

    public partial class DocumentShareExtended
        : DocumentShare
    {
        public virtual string AttachmentName { get; set; }
        public virtual string RecipientDisplayName { get; set; }
        public virtual string RecipientType { get; set; }
        public virtual string CreatedByName { get; set; }
        public virtual string Status { get; set; }
    }

    public partial class DocumentShareListRequest
    {
        public virtual Guid AttachmentId { get; set; }
    }

    public partial class DocumentShareResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<DocumentShareExtended> DocumentShare { get; set; } = [];
        public virtual string ShareUrl { get; set; }
    }

}

C# DocumentShareListRequest 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.

GET /v1/documentshare/attachment/{AttachmentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}