POST api/pdf/ApplyDrmOnCheckout

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FileName	string	None.
FileToProcess	string	None.
SetPDFToExpire	boolean	None.
ExpireOnDate	boolean	None.
ExpireAfterXdays	boolean	None.
ExpiryDate	string	None.
ExpiryTime	string	None.
ExpiryMessage	string	None.
Xdays	integer	None.
LockPDFToCountries	boolean	None.
AllowedCountries	Dictionary of string [key] and string [value]	None.
LockToIPAddresses	boolean	None.
AllowedIPAddresses	Collection of string	None.
AllowPrinting	boolean	None.
MaximumNumberOfPrints	integer	None.
PDFUserPassword	string	None.
PDFOwnerPassword	string	None.
UseCloudValidation	boolean	None.
LockToXDevices	boolean	None.
MaxDevices	integer	None.
OutputFolder	string	None.
LockToEmails	boolean	None.
AllowedEmails	Collection of string	None.
AllowWebAccess	boolean	None.
EmbedinHTML	boolean	None.
ApiKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FileName": "sample string 1",
  "FileToProcess": "sample string 2",
  "SetPDFToExpire": true,
  "ExpireOnDate": true,
  "ExpireAfterXdays": true,
  "ExpiryDate": "sample string 6",
  "ExpiryTime": "sample string 7",
  "ExpiryMessage": "sample string 8",
  "Xdays": 9,
  "LockPDFToCountries": true,
  "AllowedCountries": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "LockToIPAddresses": true,
  "AllowedIPAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "AllowPrinting": true,
  "MaximumNumberOfPrints": 13,
  "PDFUserPassword": "sample string 14",
  "PDFOwnerPassword": "sample string 15",
  "UseCloudValidation": true,
  "LockToXDevices": true,
  "MaxDevices": 18,
  "OutputFolder": "sample string 19",
  "LockToEmails": true,
  "AllowedEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "AllowWebAccess": true,
  "EmbedinHTML": true,
  "ApiKey": "sample string 23"
}

application/xml, text/xml

Sample:

<DRMSaveOptionsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/All_About_PDF">
  <AllowPrinting>true</AllowPrinting>
  <AllowWebAccess>true</AllowWebAccess>
  <AllowedCountries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </AllowedCountries>
  <AllowedEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AllowedEmails>
  <AllowedIPAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AllowedIPAddresses>
  <ApiKey>sample string 23</ApiKey>
  <EmbedinHTML>true</EmbedinHTML>
  <ExpireAfterXdays>true</ExpireAfterXdays>
  <ExpireOnDate>true</ExpireOnDate>
  <ExpiryDate>sample string 6</ExpiryDate>
  <ExpiryMessage>sample string 8</ExpiryMessage>
  <ExpiryTime>sample string 7</ExpiryTime>
  <FileName>sample string 1</FileName>
  <FileToProcess>sample string 2</FileToProcess>
  <LockPDFToCountries>true</LockPDFToCountries>
  <LockToEmails>true</LockToEmails>
  <LockToIPAddresses>true</LockToIPAddresses>
  <LockToXDevices>true</LockToXDevices>
  <MaxDevices>18</MaxDevices>
  <MaximumNumberOfPrints>13</MaximumNumberOfPrints>
  <OutputFolder>sample string 19</OutputFolder>
  <PDFOwnerPassword>sample string 15</PDFOwnerPassword>
  <PDFUserPassword>sample string 14</PDFUserPassword>
  <SetPDFToExpire>true</SetPDFToExpire>
  <UseCloudValidation>true</UseCloudValidation>
  <Xdays>9</Xdays>
</DRMSaveOptionsModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DRMSaveOptionsModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.