Trendsic Platform Service

<back to all web services

CustomerLinkListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/customerlink/resource/{ResourceType}/{ResourceUid}
CustomerLinkListRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceTypepathstringNo
ResourceUidpathGuidNo
CustomerLinkListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LinksformList<CustomerLinkExtended>No
CustomerLinkExtended Parameters:
NameParameterData TypeRequiredDescription
RecipientDisplayNameformstringNo
RecipientTypeformstringNo
StatusformstringNo
CustomerLink Parameters:
NameParameterData TypeRequiredDescription
CustomerLinkIdformintNo
CustomerLinkUIDformGuidNo
TokenHashformstringNo
ResourceTypeformstringNo
ResourceUidformGuidNo
SensitivityTierformstringNo
RequireOtpformboolNo
OtpChannelformstringNo
DeliveryChannelsformstringNo
RecipientContactIdformint?No
RecipientEmailformstringNo
RecipientPhoneformstringNo
SmsConsentSnapshotformboolNo
CreatedByUserIdformGuidNo
CreatedByAgentIdformint?No
CreatedAtUtcformDateTimeNo
ExpiresAtUtcformDateTime?No
MaxViewsformint?No
ViewCountformintNo
RevokedAtUtcformDateTime?No
RevokedByUserIdformGuid?No
TenantIdformGuidNo

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.

GET /v1/customerlink/resource/{ResourceType}/{ResourceUid} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
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"}},"Links":[{"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-01T00:00:00.0000000","ExpiresAtUtc":"0001-01-01T00:00:00.0000000","MaxViews":0,"ViewCount":0,"RevokedAtUtc":"0001-01-01T00:00:00.0000000","RevokedByUserId":"00000000000000000000000000000000","TenantId":"00000000000000000000000000000000"}]}