Trendsic Platform Service

DocumentShareRevokeRequest

The following routes are available for this service:
DELETE,OPTIONS	/v1/documentshare/{DocumentShareId}


export class DocumentShare
{
    public DocumentShareId: number;
    public DocumentShareUID: string;
    public TokenHash: string;
    public AttachmentId: string;
    public SensitivityTier: string;
    public RequireOtp: boolean;
    public OtpChannel: string;
    public DeliveryChannels: string;
    public RecipientContactId?: number;
    public RecipientEmail: string;
    public RecipientPhone: string;
    public SmsConsentSnapshot: boolean;
    public CreatedByUserId: string;
    public CreatedByAgentId?: number;
    public CreatedAtUtc: string;
    public ExpiresAtUtc: string;
    public MaxViews?: number;
    public ViewCount: number;
    public RevokedAtUtc?: string;
    public RevokedByUserId?: string;

    public constructor(init?: Partial<DocumentShare>) { (Object as any).assign(this, init); }
}

export class DocumentShareExtended extends DocumentShare
{
    public AttachmentName: string;
    public RecipientDisplayName: string;
    public RecipientType: string;
    public CreatedByName: string;
    public Status: string;

    public constructor(init?: Partial<DocumentShareExtended>) { super(init); (Object as any).assign(this, init); }
}

export class DocumentShareResponse
{
    public ResponseStatus: ResponseStatus;
    public DocumentShare: DocumentShareExtended[] = [];
    public ShareUrl: string;

    public constructor(init?: Partial<DocumentShareResponse>) { (Object as any).assign(this, init); }
}

export class DocumentShareRevokeRequest
{
    public DocumentShareId: number;

    public constructor(init?: Partial<DocumentShareRevokeRequest>) { (Object as any).assign(this, init); }
}

TypeScript DocumentShareRevokeRequest 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.

DELETE /v1/documentshare/{DocumentShareId} 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"}