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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentSharePolicy() = 
        member val DocumentSharePolicyId:Int32 = new Int32() with get,set
        member val HighTierNoSmsFallback:String = null with get,set
        member val DefaultExpiryHours:Int32 = new Int32() with get,set
        member val MaxExpiryHours:Int32 = new Int32() with get,set
        member val DefaultMaxViews:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AllowAdhocEmail:Boolean = new Boolean() with get,set
        member val UpdatedAtUtc:DateTime = new DateTime() with get,set
        member val UpdatedByUserId:Nullable<Guid> = new Nullable<Guid>() with get,set

    [<AllowNullLiteral>]
    type DocumentSharePolicyResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Policy:DocumentSharePolicy = null with get,set

    [<AllowNullLiteral>]
    type DocumentSharePolicyRequest() = 
        member val HighTierNoSmsFallback:String = null with get,set
        member val DefaultExpiryHours:Int32 = new Int32() with get,set
        member val MaxExpiryHours:Int32 = new Int32() with get,set
        member val DefaultMaxViews:Int32 = new Int32() with get,set
        member val AllowAdhocEmail:Boolean = new Boolean() with get,set

F# DocumentSharePolicyRequest DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<DocumentSharePolicyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AllowAdhocEmail>false</AllowAdhocEmail>
  <DefaultExpiryHours>0</DefaultExpiryHours>
  <DefaultMaxViews>0</DefaultMaxViews>
  <HighTierNoSmsFallback>String</HighTierNoSmsFallback>
  <MaxExpiryHours>0</MaxExpiryHours>
</DocumentSharePolicyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentSharePolicyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Policy>
    <AllowAdhocEmail>false</AllowAdhocEmail>
    <DefaultExpiryHours>0</DefaultExpiryHours>
    <DefaultMaxViews>0</DefaultMaxViews>
    <DocumentSharePolicyId>0</DocumentSharePolicyId>
    <HighTierNoSmsFallback>String</HighTierNoSmsFallback>
    <MaxExpiryHours>0</MaxExpiryHours>
    <UpdatedAtUtc>0001-01-01T00:00:00</UpdatedAtUtc>
    <UpdatedByUserId>00000000-0000-0000-0000-000000000000</UpdatedByUserId>
  </Policy>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DocumentSharePolicyResponse>