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.*;

public class dtos
{

    public static class CustomerLinkCreateRequest
    {
        public String ResourceType = null;
        public UUID ResourceUid = null;
        public Integer RecipientContactId = null;
        public String RecipientEmail = null;
        public String RecipientPhone = null;
        public Boolean DeliverEmail = null;
        public Boolean DeliverSms = null;
        public Integer ExpiresInHours = null;
        public Integer MaxViews = null;
        
        public String getResourceType() { return ResourceType; }
        public CustomerLinkCreateRequest setResourceType(String value) { this.ResourceType = value; return this; }
        public UUID getResourceUid() { return ResourceUid; }
        public CustomerLinkCreateRequest setResourceUid(UUID value) { this.ResourceUid = value; return this; }
        public Integer getRecipientContactId() { return RecipientContactId; }
        public CustomerLinkCreateRequest setRecipientContactId(Integer value) { this.RecipientContactId = value; return this; }
        public String getRecipientEmail() { return RecipientEmail; }
        public CustomerLinkCreateRequest setRecipientEmail(String value) { this.RecipientEmail = value; return this; }
        public String getRecipientPhone() { return RecipientPhone; }
        public CustomerLinkCreateRequest setRecipientPhone(String value) { this.RecipientPhone = value; return this; }
        public Boolean isDeliverEmail() { return DeliverEmail; }
        public CustomerLinkCreateRequest setDeliverEmail(Boolean value) { this.DeliverEmail = value; return this; }
        public Boolean isDeliverSms() { return DeliverSms; }
        public CustomerLinkCreateRequest setDeliverSms(Boolean value) { this.DeliverSms = value; return this; }
        public Integer getExpiresInHours() { return ExpiresInHours; }
        public CustomerLinkCreateRequest setExpiresInHours(Integer value) { this.ExpiresInHours = value; return this; }
        public Integer getMaxViews() { return MaxViews; }
        public CustomerLinkCreateRequest setMaxViews(Integer value) { this.MaxViews = value; return this; }
    }

    public static class CustomerLinkCreateResponse
    {
        public ResponseStatus ResponseStatus = null;
        public CustomerLinkExtended Link = null;
        public String PortalUrl = null;
        public ArrayList<String> DeliveryErrors = new ArrayList<String>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CustomerLinkCreateResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public CustomerLinkExtended getLink() { return Link; }
        public CustomerLinkCreateResponse setLink(CustomerLinkExtended value) { this.Link = value; return this; }
        public String getPortalUrl() { return PortalUrl; }
        public CustomerLinkCreateResponse setPortalUrl(String value) { this.PortalUrl = value; return this; }
        public ArrayList<String> getDeliveryErrors() { return DeliveryErrors; }
        public CustomerLinkCreateResponse setDeliveryErrors(ArrayList<String> value) { this.DeliveryErrors = value; return this; }
    }

    public static class CustomerLinkExtended extends CustomerLink
    {
        public String RecipientDisplayName = null;
        public String RecipientType = null;
        public String Status = null;
        
        public String getRecipientDisplayName() { return RecipientDisplayName; }
        public CustomerLinkExtended setRecipientDisplayName(String value) { this.RecipientDisplayName = value; return this; }
        public String getRecipientType() { return RecipientType; }
        public CustomerLinkExtended setRecipientType(String value) { this.RecipientType = value; return this; }
        public String getStatus() { return Status; }
        public CustomerLinkExtended setStatus(String value) { this.Status = value; return this; }
    }

    public static class CustomerLink
    {
        public Integer CustomerLinkId = null;
        public UUID CustomerLinkUID = null;
        public String TokenHash = null;
        public String ResourceType = null;
        public UUID ResourceUid = null;
        public String SensitivityTier = null;
        public Boolean RequireOtp = null;
        public String OtpChannel = null;
        public String DeliveryChannels = null;
        public Integer RecipientContactId = null;
        public String RecipientEmail = null;
        public String RecipientPhone = null;
        public Boolean SmsConsentSnapshot = null;
        public UUID CreatedByUserId = null;
        public Integer CreatedByAgentId = null;
        public Date CreatedAtUtc = null;
        public Date ExpiresAtUtc = null;
        public Integer MaxViews = null;
        public Integer ViewCount = null;
        public Date RevokedAtUtc = null;
        public UUID RevokedByUserId = null;
        public UUID TenantId = null;
        
        public Integer getCustomerLinkId() { return CustomerLinkId; }
        public CustomerLink setCustomerLinkId(Integer value) { this.CustomerLinkId = value; return this; }
        public UUID getCustomerLinkUID() { return CustomerLinkUID; }
        public CustomerLink setCustomerLinkUID(UUID value) { this.CustomerLinkUID = value; return this; }
        public String getTokenHash() { return TokenHash; }
        public CustomerLink setTokenHash(String value) { this.TokenHash = value; return this; }
        public String getResourceType() { return ResourceType; }
        public CustomerLink setResourceType(String value) { this.ResourceType = value; return this; }
        public UUID getResourceUid() { return ResourceUid; }
        public CustomerLink setResourceUid(UUID value) { this.ResourceUid = value; return this; }
        public String getSensitivityTier() { return SensitivityTier; }
        public CustomerLink setSensitivityTier(String value) { this.SensitivityTier = value; return this; }
        public Boolean isRequireOtp() { return RequireOtp; }
        public CustomerLink setRequireOtp(Boolean value) { this.RequireOtp = value; return this; }
        public String getOtpChannel() { return OtpChannel; }
        public CustomerLink setOtpChannel(String value) { this.OtpChannel = value; return this; }
        public String getDeliveryChannels() { return DeliveryChannels; }
        public CustomerLink setDeliveryChannels(String value) { this.DeliveryChannels = value; return this; }
        public Integer getRecipientContactId() { return RecipientContactId; }
        public CustomerLink setRecipientContactId(Integer value) { this.RecipientContactId = value; return this; }
        public String getRecipientEmail() { return RecipientEmail; }
        public CustomerLink setRecipientEmail(String value) { this.RecipientEmail = value; return this; }
        public String getRecipientPhone() { return RecipientPhone; }
        public CustomerLink setRecipientPhone(String value) { this.RecipientPhone = value; return this; }
        public Boolean isSmsConsentSnapshot() { return SmsConsentSnapshot; }
        public CustomerLink setSmsConsentSnapshot(Boolean value) { this.SmsConsentSnapshot = value; return this; }
        public UUID getCreatedByUserId() { return CreatedByUserId; }
        public CustomerLink setCreatedByUserId(UUID value) { this.CreatedByUserId = value; return this; }
        public Integer getCreatedByAgentId() { return CreatedByAgentId; }
        public CustomerLink setCreatedByAgentId(Integer value) { this.CreatedByAgentId = value; return this; }
        public Date getCreatedAtUtc() { return CreatedAtUtc; }
        public CustomerLink setCreatedAtUtc(Date value) { this.CreatedAtUtc = value; return this; }
        public Date getExpiresAtUtc() { return ExpiresAtUtc; }
        public CustomerLink setExpiresAtUtc(Date value) { this.ExpiresAtUtc = value; return this; }
        public Integer getMaxViews() { return MaxViews; }
        public CustomerLink setMaxViews(Integer value) { this.MaxViews = value; return this; }
        public Integer getViewCount() { return ViewCount; }
        public CustomerLink setViewCount(Integer value) { this.ViewCount = value; return this; }
        public Date getRevokedAtUtc() { return RevokedAtUtc; }
        public CustomerLink setRevokedAtUtc(Date value) { this.RevokedAtUtc = value; return this; }
        public UUID getRevokedByUserId() { return RevokedByUserId; }
        public CustomerLink setRevokedByUserId(UUID value) { this.RevokedByUserId = value; return this; }
        public UUID getTenantId() { return TenantId; }
        public CustomerLink setTenantId(UUID value) { this.TenantId = value; return this; }
    }

}

Java CustomerLinkCreateRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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-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"},"PortalUrl":"String","DeliveryErrors":["String"]}