Trendsic Platform Service

DocumentShareCreateRequest

The following routes are available for this service:
POST,OPTIONS	/v1/documentshare


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 DocumentShareCreateRequest
{
    public AttachmentId: string;
    public RecipientContactId: number;
    public RecipientEmail: string;
    public RecipientPhone: string;
    public IsAdhoc: boolean;
    public SensitivityTier: string;
    public RequireOtp: boolean;
    public OtpChannel: string;
    public DeliveryChannels: string;
    public ExpiresInHours: number;
    public MaxViews: number;

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

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

POST /v1/documentshare HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentShareCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <DeliveryChannels>String</DeliveryChannels>
  <ExpiresInHours>0</ExpiresInHours>
  <IsAdhoc>false</IsAdhoc>
  <MaxViews>0</MaxViews>
  <OtpChannel>String</OtpChannel>
  <RecipientContactId>0</RecipientContactId>
  <RecipientEmail>String</RecipientEmail>
  <RecipientPhone>String</RecipientPhone>
  <RequireOtp>false</RequireOtp>
  <SensitivityTier>String</SensitivityTier>
</DocumentShareCreateRequest>

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>