Trendsic Platform Service

<back to all web services

ShareLandingRequest

The following routes are available for this service:
GET,OPTIONS/share/{Token}
ShareLandingRequest Parameters:
NameParameterData TypeRequiredDescription
TokenpathstringNo
ShareLandingResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
StatusformstringNo
RequireOtpformboolNo
OtpChannelformstringNo
OtpSentformboolNo
DocumentNameformstringNo
CanViewformboolNo
MessageformstringNo

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.

GET /share/{Token} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Status: String,
	RequireOtp: False,
	OtpChannel: String,
	OtpSent: False,
	DocumentName: String,
	CanView: False,
	Message: String
}