Trendsic Platform Service

DocumentShareCreateRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShare:
    document_share_id: int = 0
    document_share_u_i_d: Optional[str] = None
    token_hash: Optional[str] = None
    attachment_id: Optional[str] = None
    sensitivity_tier: Optional[str] = None
    require_otp: bool = False
    otp_channel: Optional[str] = None
    delivery_channels: Optional[str] = None
    recipient_contact_id: Optional[int] = None
    recipient_email: Optional[str] = None
    recipient_phone: Optional[str] = None
    sms_consent_snapshot: bool = False
    created_by_user_id: Optional[str] = None
    created_by_agent_id: Optional[int] = None
    created_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    expires_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    max_views: Optional[int] = None
    view_count: int = 0
    revoked_at_utc: Optional[datetime.datetime] = None
    revoked_by_user_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareExtended(DocumentShare):
    attachment_name: Optional[str] = None
    recipient_display_name: Optional[str] = None
    recipient_type: Optional[str] = None
    created_by_name: Optional[str] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareResponse:
    response_status: Optional[ResponseStatus] = None
    document_share: List[DocumentShareExtended] = field(default_factory=list)
    share_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareCreateRequest:
    attachment_id: Optional[str] = None
    recipient_contact_id: int = 0
    recipient_email: Optional[str] = None
    recipient_phone: Optional[str] = None
    is_adhoc: bool = False
    sensitivity_tier: Optional[str] = None
    require_otp: bool = False
    otp_channel: Optional[str] = None
    delivery_channels: Optional[str] = None
    expires_in_hours: int = 0
    max_views: int = 0

Python 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>