Trendsic Platform Service

DocumentShareRevokeRequest

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

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 DocumentShareResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<DocumentShareExtended> DocumentShare { get; set; } = [];
        public virtual string ShareUrl { get; set; }
    }

    public partial class DocumentShareRevokeRequest
    {
        public virtual int DocumentShareId { get; set; }
    }

}

C# DocumentShareRevokeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentShareResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DocumentShare>
    <DocumentShareExtended>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
      <CreatedByAgentId>0</CreatedByAgentId>
      <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
      <DeliveryChannels>String</DeliveryChannels>
      <DocumentShareId>0</DocumentShareId>
      <DocumentShareUID>00000000-0000-0000-0000-000000000000</DocumentShareUID>
      <ExpiresAtUtc>0001-01-01T00:00:00</ExpiresAtUtc>
      <MaxViews>0</MaxViews>
      <OtpChannel>String</OtpChannel>
      <RecipientContactId>0</RecipientContactId>
      <RecipientEmail>String</RecipientEmail>
      <RecipientPhone>String</RecipientPhone>
      <RequireOtp>false</RequireOtp>
      <RevokedAtUtc>0001-01-01T00:00:00</RevokedAtUtc>
      <RevokedByUserId>00000000-0000-0000-0000-000000000000</RevokedByUserId>
      <SensitivityTier>String</SensitivityTier>
      <SmsConsentSnapshot>false</SmsConsentSnapshot>
      <TokenHash>String</TokenHash>
      <ViewCount>0</ViewCount>
      <AttachmentName>String</AttachmentName>
      <CreatedByName>String</CreatedByName>
      <RecipientDisplayName>String</RecipientDisplayName>
      <RecipientType>String</RecipientType>
      <Status>String</Status>
    </DocumentShareExtended>
  </DocumentShare>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ShareUrl>String</ShareUrl>
</DocumentShareResponse>