GET api/Configuration/SmartSafeSettings/{clientId}
Gets the smart safe settings by client id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
The client id. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ESignSystems.SmartSAFE.Models.Configuration.SmartSafeSettingsModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SmartSafeSettingsId |
Gets or sets the smart safe settings identifier. |
integer |
None. |
| ClientId |
Gets or sets the id of the client that the settings are for. |
integer |
None. |
| OrganizationId |
Gets or sets the OrganizationId. |
integer |
None. |
| UseWatermarkForSignedDocuments |
Gets or sets a value indicating whether are watermark image should be placed on all signed documents when they are downloaded. |
boolean |
Required |
| WatermarkImage |
Gets or sets the image to use to apply to a signed document. |
Collection of byte |
None. |
| UseWatermarkForAuthoritativeDocuments |
Gets or sets a value indicating whether the authoritative watermark image should be placed on all authoritative documents when they are downloaded. |
boolean |
None. |
| AuthoritativeWatermarkImage |
Gets or sets the image to use to apply to an authoritative document. |
Collection of byte |
None. |
| UseWatermarkForTransferableDocuments |
Gets or sets a value indicating whether the transferable watermark image should be placed on all transferable documents when they are downloaded. |
boolean |
None. |
| TransferableWatermarkImage |
Gets or sets the image to use to apply to a transferable document. |
Collection of byte |
None. |
| NumberOfNotificationAttempts |
Gets or sets the number of notification attempts. |
integer |
Required |
| ApplicationTitle |
Gets or sets the Application Title. |
string |
Required Max length: 30 |
| SAFELogo |
Gets or sets the SAFE Logo. |
Collection of byte |
Required |
| SAFELogoBase64 |
Gets the SafeLogo in base 64 string. |
string |
None. |
| HeaderBarColor |
Gets or sets the HeaderBarColor. |
string |
Required |
| HeaderBarTextColor |
Gets or sets the HeaderBarColorText. |
string |
Required |
| LogWebServiceCalls |
Gets or sets a value indicating whether or not web service calls are logged. |
boolean |
Required |
| LogWebServiceErrorsOnly |
Gets or sets a value indicating whether or not only web service errors are logged. |
boolean |
Required |
| EnableFooter |
Gets or sets a value indicating whether [enable footer]. |
boolean |
Required |
| IncludeFooterDocumentName |
Gets or sets a value indicating whether [include footer document name]. |
boolean |
Required |
| IncludeFooterImage |
Gets or sets a value indicating whether [include footer image]. |
boolean |
Required |
| FooterText |
Gets or sets the footer text. |
string |
Max length: 50 |
| FooterImage |
Gets or sets the footer image. |
Collection of byte |
None. |
| UDF1Name |
Gets or sets the name of UDF1. |
string |
Required Max length: 256 |
| UDF2Name |
Gets or sets the name of UDF2. |
string |
Required Max length: 256 |
| UDF3Name |
Gets or sets the name of UDF3. |
string |
Required Max length: 256 |
| SmartSAFEUrl |
Gets or sets the SigningRoom settings' SmartSAFE URL. |
string |
Max length: 255 |
| ServerTimeZone |
Gets or sets the time zone of the server. |
string |
None. |
| ServerTimeZoneOffset |
Gets or sets the time zone offset of the server in minutes. |
integer |
None. |
| LogEVaultActivity |
Gets or sets whether to log eVault activity. |
boolean |
None. |
| DisplayWatermarkOnTop |
Gets or sets whether to display the watermark on top. |
boolean |
Required |
| ApplyToAll |
Gets or sets a value indicating whether the saved settings should be applied to all potential subordinate organization or client settings depending on the hierarchy. |
boolean |
None. |
Response Formats
application/json, text/json
{
"SmartSafeSettingsId": 1,
"ClientId": 1,
"OrganizationId": 1,
"UseWatermarkForSignedDocuments": true,
"WatermarkImage": "QEA=",
"UseWatermarkForAuthoritativeDocuments": true,
"AuthoritativeWatermarkImage": "QEA=",
"UseWatermarkForTransferableDocuments": true,
"TransferableWatermarkImage": "QEA=",
"NumberOfNotificationAttempts": 1,
"ApplicationTitle": "sample string 4",
"SAFELogo": "QEA=",
"SAFELogoBase64": "QEA=",
"HeaderBarColor": "sample string 5",
"HeaderBarTextColor": "sample string 6",
"LogWebServiceCalls": true,
"LogWebServiceErrorsOnly": true,
"EnableFooter": true,
"IncludeFooterDocumentName": true,
"IncludeFooterImage": true,
"FooterText": "sample string 12",
"FooterImage": "QEA=",
"UDF1Name": "sample string 13",
"UDF2Name": "sample string 14",
"UDF3Name": "sample string 15",
"SmartSAFEUrl": "sample string 16",
"ServerTimeZone": "sample string 17",
"ServerTimeZoneOffset": 1,
"LogEVaultActivity": true,
"DisplayWatermarkOnTop": true,
"ApplyToAll": true
}
application/xml, text/xml
<SmartSafeSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Configuration"> <ApplicationTitle>sample string 4</ApplicationTitle> <ApplyToAll>true</ApplyToAll> <AuthoritativeWatermarkImage>QEA=</AuthoritativeWatermarkImage> <ClientId>1</ClientId> <DisplayWatermarkOnTop>true</DisplayWatermarkOnTop> <EnableFooter>true</EnableFooter> <FooterImage>QEA=</FooterImage> <FooterText>sample string 12</FooterText> <HeaderBarColor>sample string 5</HeaderBarColor> <HeaderBarTextColor>sample string 6</HeaderBarTextColor> <IncludeFooterDocumentName>true</IncludeFooterDocumentName> <IncludeFooterImage>true</IncludeFooterImage> <LogEVaultActivity>true</LogEVaultActivity> <LogWebServiceCalls>true</LogWebServiceCalls> <LogWebServiceErrorsOnly>true</LogWebServiceErrorsOnly> <NumberOfNotificationAttempts>1</NumberOfNotificationAttempts> <OrganizationId>1</OrganizationId> <SAFELogo>QEA=</SAFELogo> <ServerTimeZone>sample string 17</ServerTimeZone> <ServerTimeZoneOffset>1</ServerTimeZoneOffset> <SmartSAFEUrl>sample string 16</SmartSAFEUrl> <SmartSafeSettingsId>1</SmartSafeSettingsId> <TransferableWatermarkImage>QEA=</TransferableWatermarkImage> <UDF1Name>sample string 13</UDF1Name> <UDF2Name>sample string 14</UDF2Name> <UDF3Name>sample string 15</UDF3Name> <UseWatermarkForAuthoritativeDocuments>true</UseWatermarkForAuthoritativeDocuments> <UseWatermarkForSignedDocuments>true</UseWatermarkForSignedDocuments> <UseWatermarkForTransferableDocuments>true</UseWatermarkForTransferableDocuments> <WatermarkImage>QEA=</WatermarkImage> </SmartSafeSettingsModel>