POST api/SmartTransfer/ExternalEVaultIntegrationSettings

Provides the ability to save external eVault integration settings.

Request Information

URI Parameters

None.

Body Parameters

The external eVault integration settings model.

ESignSystems.SmartSAFE.Models.SmartTransfer.ExternalEVaultIntegrationSettingsModel
NameDescriptionTypeAdditional information
ExternalEVaultIntegrationSettingsId

Gets or sets the external eVault integration settings identifier.

 integer

None.
ClientId

Gets or sets the client identifier.

 integer

Required
ClientName

Gets or sets the client name that owns the settings.

 string

None.
ExternalEVaultName

Gets or sets the external eVault name.

 string

Required

Max length: 256
AccountId

Gets or sets the account identifier for the client in the external eVault.

 string

Required

Max length: 256
IntegrationKey

Gets or sets the integration key.

 string

Required

Max length: 256
UserId

Gets or sets the user identifier.

 string

Required

Max length: 256
Password

Gets or sets the password.

 string

Max length: 256
MarkAllDocumentsAsEChattel

Gets or sets a value indicating whether to automatically select Electronic Chattel Paper as the document's type for incoming transfers.

 boolean

None.
UDF1CustomFieldName

Gets or sets the UDF1 custom field name.

 string

Max length: 256
UDF2CustomFieldName

Gets or sets the UDF2 custom field name.

 string

Max length: 256
Active

Gets or sets a value indicating whether the settings are active.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "ExternalEVaultIntegrationSettingsId": 1,
  "ClientId": 1,
  "ClientName": "sample string 1",
  "ExternalEVaultName": "sample string 2",
  "AccountId": "sample string 3",
  "IntegrationKey": "sample string 4",
  "UserId": "sample string 5",
  "Password": "sample string 6",
  "MarkAllDocumentsAsEChattel": true,
  "UDF1CustomFieldName": "sample string 8",
  "UDF2CustomFieldName": "sample string 9",
  "Active": true
}

application/xml, text/xml

Sample: 
<ExternalEVaultIntegrationSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <AccountId>sample string 3</AccountId>
  <Active>true</Active>
  <ClientId>1</ClientId>
  <ClientName>sample string 1</ClientName>
  <ExternalEVaultIntegrationSettingsId>1</ExternalEVaultIntegrationSettingsId>
  <ExternalEVaultName>sample string 2</ExternalEVaultName>
  <IntegrationKey>sample string 4</IntegrationKey>
  <MarkAllDocumentsAsEChattel>true</MarkAllDocumentsAsEChattel>
  <Password>sample string 6</Password>
  <UDF1CustomFieldName>sample string 8</UDF1CustomFieldName>
  <UDF2CustomFieldName>sample string 9</UDF2CustomFieldName>
  <UserId>sample string 5</UserId>
</ExternalEVaultIntegrationSettingsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A success or failure.

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.