POST api/Configuration/DocumentTypes

Allows a client admin to update a document type associated with the client.

Request Information

URI Parameters

None.

Body Parameters

The document type to update.

ESignSystems.SmartSAFE.Models.Configuration.DocumentTypeModel
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier of the document type.

integer

None.

ClientId

Gets or sets the client identifier.

integer

None.

Active

Gets or sets a value indicating whether the document type is active.

boolean

None.

LookupValue

Gets or sets the document type's lookup value.

string

Required

Max length: 256

CodeDependent

Gets or sets a value indicating whether the document type is code dependent.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ClientId": 1,
  "Active": true,
  "LookupValue": "sample string 2",
  "CodeDependent": true
}

application/xml, text/xml

Sample:
<DocumentTypeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Configuration">
  <Active>true</Active>
  <ClientId>1</ClientId>
  <CodeDependent>true</CodeDependent>
  <Id>1</Id>
  <LookupValue>sample string 2</LookupValue>
</DocumentTypeModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.