Trendsic Platform Service

<back to all web services

ShareLandingRequest

The following routes are available for this service:
GET,OPTIONS/share/{Token}
"use strict";
export class ShareLandingResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Status?:string,RequireOtp?:boolean,OtpChannel?:string,OtpSent?:boolean,DocumentName?:string,CanView?:boolean,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {string} */
    Status;
    /** @type {boolean} */
    RequireOtp;
    /** @type {string} */
    OtpChannel;
    /** @type {boolean} */
    OtpSent;
    /** @type {string} */
    DocumentName;
    /** @type {boolean} */
    CanView;
    /** @type {string} */
    Message;
}
export class ShareLandingRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

JavaScript ShareLandingRequest 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.

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
}