Trendsic Platform Service

CustomerLinkCreateRequest

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


export class CustomerLink
{
    public CustomerLinkId: number;
    public CustomerLinkUID: string;
    public TokenHash: string;
    public ResourceType: string;
    public ResourceUid: string;
    public SensitivityTier: string;
    public RequireOtp: boolean;
    public OtpChannel: string;
    public DeliveryChannels: string;
    public RecipientContactId?: number;
    public RecipientEmail: string;
    public RecipientPhone: string;
    public SmsConsentSnapshot: boolean;
    public CreatedByUserId: string;
    public CreatedByAgentId?: number;
    public CreatedAtUtc: string;
    public ExpiresAtUtc?: string;
    public MaxViews?: number;
    public ViewCount: number;
    public RevokedAtUtc?: string;
    public RevokedByUserId?: string;
    public TenantId: string;

    public constructor(init?: Partial<CustomerLink>) { (Object as any).assign(this, init); }
}

export class CustomerLinkExtended extends CustomerLink
{
    public RecipientDisplayName: string;
    public RecipientType: string;
    public Status: string;

    public constructor(init?: Partial<CustomerLinkExtended>) { super(init); (Object as any).assign(this, init); }
}

export class CustomerLinkCreateResponse
{
    public ResponseStatus: ResponseStatus;
    public Link: CustomerLinkExtended;
    public PortalUrl: string;
    public DeliveryErrors: string[] = [];

    public constructor(init?: Partial<CustomerLinkCreateResponse>) { (Object as any).assign(this, init); }
}

export class CustomerLinkCreateRequest
{
    public ResourceType: string;
    public ResourceUid: string;
    public RecipientContactId?: number;
    public RecipientEmail: string;
    public RecipientPhone: string;
    public DeliverEmail: boolean;
    public DeliverSms: boolean;
    public ExpiresInHours?: number;
    public MaxViews?: number;

    public constructor(init?: Partial<CustomerLinkCreateRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	]
}