Trendsic Platform Service

<back to all web services

CustomerLinkCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/customerlink
"use strict";
export class CustomerLink {
    /** @param {{CustomerLinkId?:number,CustomerLinkUID?:string,TokenHash?:string,ResourceType?:string,ResourceUid?:string,SensitivityTier?:string,RequireOtp?:boolean,OtpChannel?:string,DeliveryChannels?:string,RecipientContactId?:number,RecipientEmail?:string,RecipientPhone?:string,SmsConsentSnapshot?:boolean,CreatedByUserId?:string,CreatedByAgentId?:number,CreatedAtUtc?:string,ExpiresAtUtc?:string,MaxViews?:number,ViewCount?:number,RevokedAtUtc?:string,RevokedByUserId?:string,TenantId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CustomerLinkId;
    /** @type {string} */
    CustomerLinkUID;
    /** @type {string} */
    TokenHash;
    /** @type {string} */
    ResourceType;
    /** @type {string} */
    ResourceUid;
    /** @type {string} */
    SensitivityTier;
    /** @type {boolean} */
    RequireOtp;
    /** @type {string} */
    OtpChannel;
    /** @type {string} */
    DeliveryChannels;
    /** @type {?number} */
    RecipientContactId;
    /** @type {string} */
    RecipientEmail;
    /** @type {string} */
    RecipientPhone;
    /** @type {boolean} */
    SmsConsentSnapshot;
    /** @type {string} */
    CreatedByUserId;
    /** @type {?number} */
    CreatedByAgentId;
    /** @type {string} */
    CreatedAtUtc;
    /** @type {?string} */
    ExpiresAtUtc;
    /** @type {?number} */
    MaxViews;
    /** @type {number} */
    ViewCount;
    /** @type {?string} */
    RevokedAtUtc;
    /** @type {?string} */
    RevokedByUserId;
    /** @type {string} */
    TenantId;
}
export class CustomerLinkExtended extends CustomerLink {
    /** @param {{RecipientDisplayName?:string,RecipientType?:string,Status?:string,CustomerLinkId?:number,CustomerLinkUID?:string,TokenHash?:string,ResourceType?:string,ResourceUid?:string,SensitivityTier?:string,RequireOtp?:boolean,OtpChannel?:string,DeliveryChannels?:string,RecipientContactId?:number,RecipientEmail?:string,RecipientPhone?:string,SmsConsentSnapshot?:boolean,CreatedByUserId?:string,CreatedByAgentId?:number,CreatedAtUtc?:string,ExpiresAtUtc?:string,MaxViews?:number,ViewCount?:number,RevokedAtUtc?:string,RevokedByUserId?:string,TenantId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RecipientDisplayName;
    /** @type {string} */
    RecipientType;
    /** @type {string} */
    Status;
}
export class CustomerLinkCreateResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Link?:CustomerLinkExtended,PortalUrl?:string,DeliveryErrors?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CustomerLinkExtended} */
    Link;
    /** @type {string} */
    PortalUrl;
    /** @type {string[]} */
    DeliveryErrors = [];
}
export class CustomerLinkCreateRequest {
    /** @param {{ResourceType?:string,ResourceUid?:string,RecipientContactId?:number,RecipientEmail?:string,RecipientPhone?:string,DeliverEmail?:boolean,DeliverSms?:boolean,ExpiresInHours?:number,MaxViews?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ResourceType;
    /** @type {string} */
    ResourceUid;
    /** @type {?number} */
    RecipientContactId;
    /** @type {string} */
    RecipientEmail;
    /** @type {string} */
    RecipientPhone;
    /** @type {boolean} */
    DeliverEmail;
    /** @type {boolean} */
    DeliverSms;
    /** @type {?number} */
    ExpiresInHours;
    /** @type {?number} */
    MaxViews;
}

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