| GET,OPTIONS | /v1/documentshare/attachment/{AttachmentId} |
|---|
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 DocumentShareListRequest() =
member val AttachmentId:Guid = new Guid() with get,set
F# DocumentShareListRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/documentshare/attachment/{AttachmentId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
DocumentShare:
[
{
AttachmentName: String,
RecipientDisplayName: String,
RecipientType: String,
CreatedByName: String,
Status: String,
DocumentShareId: 0,
DocumentShareUID: 00000000000000000000000000000000,
TokenHash: String,
AttachmentId: 00000000000000000000000000000000,
SensitivityTier: String,
RequireOtp: False,
OtpChannel: String,
DeliveryChannels: String,
RecipientContactId: 0,
RecipientEmail: String,
RecipientPhone: String,
SmsConsentSnapshot: False,
CreatedByUserId: 00000000000000000000000000000000,
CreatedByAgentId: 0,
CreatedAtUtc: 0001-01-01,
ExpiresAtUtc: 0001-01-01,
MaxViews: 0,
ViewCount: 0,
RevokedAtUtc: 0001-01-01,
RevokedByUserId: 00000000000000000000000000000000
}
],
ShareUrl: String
}