Trendsic Platform Service

<back to all web services

CustomerLinkCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/customerlink
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CustomerLinkCreateRequest
{
    open var ResourceType:String? = null
    open var ResourceUid:UUID? = null
    open var RecipientContactId:Int? = null
    open var RecipientEmail:String? = null
    open var RecipientPhone:String? = null
    open var DeliverEmail:Boolean? = null
    open var DeliverSms:Boolean? = null
    open var ExpiresInHours:Int? = null
    open var MaxViews:Int? = null
}

open class CustomerLinkCreateResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Link:CustomerLinkExtended? = null
    open var PortalUrl:String? = null
    open var DeliveryErrors:ArrayList<String> = ArrayList<String>()
}

open class CustomerLinkExtended : CustomerLink()
{
    open var RecipientDisplayName:String? = null
    open var RecipientType:String? = null
    open var Status:String? = null
}

open class CustomerLink
{
    open var CustomerLinkId:Int? = null
    open var CustomerLinkUID:UUID? = null
    open var TokenHash:String? = null
    open var ResourceType:String? = null
    open var ResourceUid:UUID? = null
    open var SensitivityTier:String? = null
    open var RequireOtp:Boolean? = null
    open var OtpChannel:String? = null
    open var DeliveryChannels:String? = null
    open var RecipientContactId:Int? = null
    open var RecipientEmail:String? = null
    open var RecipientPhone:String? = null
    open var SmsConsentSnapshot:Boolean? = null
    open var CreatedByUserId:UUID? = null
    open var CreatedByAgentId:Int? = null
    open var CreatedAtUtc:Date? = null
    open var ExpiresAtUtc:Date? = null
    open var MaxViews:Int? = null
    open var ViewCount:Int? = null
    open var RevokedAtUtc:Date? = null
    open var RevokedByUserId:UUID? = null
    open var TenantId:UUID? = null
}

Kotlin CustomerLinkCreateRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/customerlink HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ResourceType: String,
	ResourceUid: 00000000000000000000000000000000,
	RecipientContactId: 0,
	RecipientEmail: String,
	RecipientPhone: String,
	DeliverEmail: False,
	DeliverSms: False,
	ExpiresInHours: 0,
	MaxViews: 0
}
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
		}
	},
	Link: 
	{
		RecipientDisplayName: String,
		RecipientType: String,
		Status: String,
		CustomerLinkId: 0,
		CustomerLinkUID: 00000000000000000000000000000000,
		TokenHash: String,
		ResourceType: String,
		ResourceUid: 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,
		TenantId: 00000000000000000000000000000000
	},
	PortalUrl: String,
	DeliveryErrors: 
	[
		String
	]
}