Trendsic Platform Service

<back to all web services

DocumentSharePolicyRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/documentshare/policy

export class DocumentSharePolicy
{
    public DocumentSharePolicyId: number;
    public HighTierNoSmsFallback: string;
    public DefaultExpiryHours: number;
    public MaxExpiryHours: number;
    public DefaultMaxViews?: number;
    public AllowAdhocEmail: boolean;
    public UpdatedAtUtc: string;
    public UpdatedByUserId?: string;

    public constructor(init?: Partial<DocumentSharePolicy>) { (Object as any).assign(this, init); }
}

export class DocumentSharePolicyResponse
{
    public ResponseStatus: ResponseStatus;
    public Policy: DocumentSharePolicy;

    public constructor(init?: Partial<DocumentSharePolicyResponse>) { (Object as any).assign(this, init); }
}

export class DocumentSharePolicyRequest
{
    public HighTierNoSmsFallback: string;
    public DefaultExpiryHours: number;
    public MaxExpiryHours: number;
    public DefaultMaxViews: number;
    public AllowAdhocEmail: boolean;

    public constructor(init?: Partial<DocumentSharePolicyRequest>) { (Object as any).assign(this, init); }
}

TypeScript DocumentSharePolicyRequest 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.

PUT /v1/documentshare/policy HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	HighTierNoSmsFallback: String,
	DefaultExpiryHours: 0,
	MaxExpiryHours: 0,
	DefaultMaxViews: 0,
	AllowAdhocEmail: False
}
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
		}
	},
	Policy: 
	{
		DocumentSharePolicyId: 0,
		HighTierNoSmsFallback: String,
		DefaultExpiryHours: 0,
		MaxExpiryHours: 0,
		DefaultMaxViews: 0,
		AllowAdhocEmail: False,
		UpdatedAtUtc: 0001-01-01,
		UpdatedByUserId: 00000000000000000000000000000000
	}
}