| POST,OPTIONS | /v1/documentshare |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type DocumentShare() =
member val DocumentShareId:Int32 = new Int32() with get,set
member val DocumentShareUID:Guid = new Guid() with get,set
member val TokenHash:String = null with get,set
member val AttachmentId:Guid = new Guid() with get,set
member val SensitivityTier:String = null with get,set
member val RequireOtp:Boolean = new Boolean() with get,set
member val OtpChannel:String = null with get,set
member val DeliveryChannels:String = null with get,set
member val RecipientContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RecipientEmail:String = null with get,set
member val RecipientPhone:String = null with get,set
member val SmsConsentSnapshot:Boolean = new Boolean() with get,set
member val CreatedByUserId:Guid = new Guid() with get,set
member val CreatedByAgentId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val CreatedAtUtc:DateTime = new DateTime() with get,set
member val ExpiresAtUtc:DateTime = new DateTime() with get,set
member val MaxViews:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ViewCount:Int32 = new Int32() with get,set
member val RevokedAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val RevokedByUserId:Nullable<Guid> = new Nullable<Guid>() with get,set
[<AllowNullLiteral>]
type DocumentShareExtended() =
inherit DocumentShare()
member val AttachmentName:String = null with get,set
member val RecipientDisplayName:String = null with get,set
member val RecipientType:String = null with get,set
member val CreatedByName:String = null with get,set
member val Status:String = null with get,set
[<AllowNullLiteral>]
type DocumentShareResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val DocumentShare:ResizeArray<DocumentShareExtended> = new ResizeArray<DocumentShareExtended>() with get,set
member val ShareUrl:String = null with get,set
[<AllowNullLiteral>]
type DocumentShareCreateRequest() =
member val AttachmentId:Guid = new Guid() with get,set
member val RecipientContactId:Int32 = new Int32() with get,set
member val RecipientEmail:String = null with get,set
member val RecipientPhone:String = null with get,set
member val IsAdhoc:Boolean = new Boolean() with get,set
member val SensitivityTier:String = null with get,set
member val RequireOtp:Boolean = new Boolean() with get,set
member val OtpChannel:String = null with get,set
member val DeliveryChannels:String = null with get,set
member val ExpiresInHours:Int32 = new Int32() with get,set
member val MaxViews:Int32 = new Int32() with get,set
F# DocumentShareCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>