Trendsic Platform Service

DocumentShareCreateRequest

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

import Foundation
import ServiceStack

public class DocumentShareCreateRequest : Codable
{
    public var attachmentId:String
    public var recipientContactId:Int
    public var recipientEmail:String
    public var recipientPhone:String
    public var isAdhoc:Bool
    public var sensitivityTier:String
    public var requireOtp:Bool
    public var otpChannel:String
    public var deliveryChannels:String
    public var expiresInHours:Int
    public var maxViews:Int

    required public init(){}
}

public class DocumentShareResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var documentShare:[DocumentShareExtended] = []
    public var shareUrl:String

    required public init(){}
}

public class DocumentShareExtended : DocumentShare
{
    public var attachmentName:String
    public var recipientDisplayName:String
    public var recipientType:String
    public var createdByName:String
    public var status:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case attachmentName
        case recipientDisplayName
        case recipientType
        case createdByName
        case status
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        attachmentName = try container.decodeIfPresent(String.self, forKey: .attachmentName)
        recipientDisplayName = try container.decodeIfPresent(String.self, forKey: .recipientDisplayName)
        recipientType = try container.decodeIfPresent(String.self, forKey: .recipientType)
        createdByName = try container.decodeIfPresent(String.self, forKey: .createdByName)
        status = try container.decodeIfPresent(String.self, forKey: .status)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if attachmentName != nil { try container.encode(attachmentName, forKey: .attachmentName) }
        if recipientDisplayName != nil { try container.encode(recipientDisplayName, forKey: .recipientDisplayName) }
        if recipientType != nil { try container.encode(recipientType, forKey: .recipientType) }
        if createdByName != nil { try container.encode(createdByName, forKey: .createdByName) }
        if status != nil { try container.encode(status, forKey: .status) }
    }
}

public class DocumentShare : Codable
{
    public var documentShareId:Int
    public var documentShareUID:String
    public var tokenHash:String
    public var attachmentId:String
    public var sensitivityTier:String
    public var requireOtp:Bool
    public var otpChannel:String
    public var deliveryChannels:String
    public var recipientContactId:Int?
    public var recipientEmail:String
    public var recipientPhone:String
    public var smsConsentSnapshot:Bool
    public var createdByUserId:String
    public var createdByAgentId:Int?
    public var createdAtUtc:Date
    public var expiresAtUtc:Date
    public var maxViews:Int?
    public var viewCount:Int
    public var revokedAtUtc:Date?
    public var revokedByUserId:String?

    required public init(){}
}

Swift DocumentShareCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AttachmentId":"00000000000000000000000000000000","RecipientContactId":0,"RecipientEmail":"String","RecipientPhone":"String","IsAdhoc":false,"SensitivityTier":"String","RequireOtp":false,"OtpChannel":"String","DeliveryChannels":"String","ExpiresInHours":0,"MaxViews":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","ExpiresAtUtc":"0001-01-01T00:00:00.0000000","MaxViews":0,"ViewCount":0,"RevokedAtUtc":"0001-01-01T00:00:00.0000000","RevokedByUserId":"00000000000000000000000000000000"}],"ShareUrl":"String"}