Trendsic Platform Service

DocumentShareRevokeRequest

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DocumentShare
            Public Overridable Property DocumentShareId As Integer
            Public Overridable Property DocumentShareUID As Guid
            Public Overridable Property TokenHash As String
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property SensitivityTier As String
            Public Overridable Property RequireOtp As Boolean
            Public Overridable Property OtpChannel As String
            Public Overridable Property DeliveryChannels As String
            Public Overridable Property RecipientContactId As Integer?
            Public Overridable Property RecipientEmail As String
            Public Overridable Property RecipientPhone As String
            Public Overridable Property SmsConsentSnapshot As Boolean
            Public Overridable Property CreatedByUserId As Guid
            Public Overridable Property CreatedByAgentId As Integer?
            Public Overridable Property CreatedAtUtc As Date
            Public Overridable Property ExpiresAtUtc As Date
            Public Overridable Property MaxViews As Integer?
            Public Overridable Property ViewCount As Integer
            Public Overridable Property RevokedAtUtc As Date?
            Public Overridable Property RevokedByUserId As Guid?
        End Class

        Public Partial Class DocumentShareExtended
            Inherits DocumentShare
            Public Overridable Property AttachmentName As String
            Public Overridable Property RecipientDisplayName As String
            Public Overridable Property RecipientType As String
            Public Overridable Property CreatedByName As String
            Public Overridable Property Status As String
        End Class

        Public Partial Class DocumentShareResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property DocumentShare As List(Of DocumentShareExtended) = New List(Of DocumentShareExtended)
            Public Overridable Property ShareUrl As String
        End Class

        Public Partial Class DocumentShareRevokeRequest
            Public Overridable Property DocumentShareId As Integer
        End Class
    End Namespace
End Namespace

VB.NET 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>