GET api/Configuration/DocumentTypes/{clientId}/AllActive

Allows a user to get a list of all active document types for the client id specified, including the SigningRoom Audit Trail Certificate document type.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The client identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The list of the specified client's active document types.

Collection of ESignSystems.SmartSAFE.Models.Configuration.DocumentTypeModel

Name	Description	Type	Additional 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.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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