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
"use strict";
export class DocumentSharePolicy {
    /** @param {{DocumentSharePolicyId?:number,HighTierNoSmsFallback?:string,DefaultExpiryHours?:number,MaxExpiryHours?:number,DefaultMaxViews?:number,AllowAdhocEmail?:boolean,UpdatedAtUtc?:string,UpdatedByUserId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentSharePolicyId;
    /** @type {string} */
    HighTierNoSmsFallback;
    /** @type {number} */
    DefaultExpiryHours;
    /** @type {number} */
    MaxExpiryHours;
    /** @type {?number} */
    DefaultMaxViews;
    /** @type {boolean} */
    AllowAdhocEmail;
    /** @type {string} */
    UpdatedAtUtc;
    /** @type {?string} */
    UpdatedByUserId;
}
export class DocumentSharePolicyResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Policy?:DocumentSharePolicy}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DocumentSharePolicy} */
    Policy;
}
export class DocumentSharePolicyRequest {
    /** @param {{HighTierNoSmsFallback?:string,DefaultExpiryHours?:number,MaxExpiryHours?:number,DefaultMaxViews?:number,AllowAdhocEmail?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    HighTierNoSmsFallback;
    /** @type {number} */
    DefaultExpiryHours;
    /** @type {number} */
    MaxExpiryHours;
    /** @type {number} */
    DefaultMaxViews;
    /** @type {boolean} */
    AllowAdhocEmail;
}

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

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

{"HighTierNoSmsFallback":"String","DefaultExpiryHours":0,"MaxExpiryHours":0,"DefaultMaxViews":0,"AllowAdhocEmail":false}

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