POST 17.0/database/certificatetypes/list

Description

Retrieve a list of Certificate Types

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of CertificateTypesUpdate
Name Description Type Additional information
ID

integer

None.
Description

string

String length: inclusive between 0 and 50
IssuerTypeID

byte

None.
Duration

integer

None.
ExpiryReminder

byte

None.
RequiresProperty

byte

None.
AllowOnlyOneActive

byte

None.
RequiresRentalIntroductions

byte

None.
RequiresRentalRentCollect

byte

None.
RequiresRentalFullManagement

byte

None.
RequiresHMO

byte

None.
RequiresGas

byte

None.
RequiresElectric

byte

None.
RequiresOpenFireStove

byte

None.
ShowAsReminder

byte

None.
OrderAction

byte

None.
SendToOwner

byte

None.
SendToTenant

byte

None.
InActive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 1",
    "issuerTypeID": 64,
    "duration": 1,
    "expiryReminder": 64,
    "requiresProperty": 64,
    "allowOnlyOneActive": 64,
    "requiresRentalIntroductions": 64,
    "requiresRentalRentCollect": 64,
    "requiresRentalFullManagement": 64,
    "requiresHMO": 64,
    "requiresGas": 64,
    "requiresElectric": 64,
    "requiresOpenFireStove": 64,
    "showAsReminder": 64,
    "orderAction": 64,
    "sendToOwner": 64,
    "sendToTenant": 64,
    "inActive": 64
  },
  {
    "id": 1,
    "description": "sample string 1",
    "issuerTypeID": 64,
    "duration": 1,
    "expiryReminder": 64,
    "requiresProperty": 64,
    "allowOnlyOneActive": 64,
    "requiresRentalIntroductions": 64,
    "requiresRentalRentCollect": 64,
    "requiresRentalFullManagement": 64,
    "requiresHMO": 64,
    "requiresGas": 64,
    "requiresElectric": 64,
    "requiresOpenFireStove": 64,
    "showAsReminder": 64,
    "orderAction": 64,
    "sendToOwner": 64,
    "sendToTenant": 64,
    "inActive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfCertificateTypesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CertificateTypesUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <IssuerTypeID>64</IssuerTypeID>
    <Duration>1</Duration>
    <ExpiryReminder>64</ExpiryReminder>
    <RequiresProperty>64</RequiresProperty>
    <AllowOnlyOneActive>64</AllowOnlyOneActive>
    <RequiresRentalIntroductions>64</RequiresRentalIntroductions>
    <RequiresRentalRentCollect>64</RequiresRentalRentCollect>
    <RequiresRentalFullManagement>64</RequiresRentalFullManagement>
    <RequiresHMO>64</RequiresHMO>
    <RequiresGas>64</RequiresGas>
    <RequiresElectric>64</RequiresElectric>
    <RequiresOpenFireStove>64</RequiresOpenFireStove>
    <ShowAsReminder>64</ShowAsReminder>
    <OrderAction>64</OrderAction>
    <SendToOwner>64</SendToOwner>
    <SendToTenant>64</SendToTenant>
    <InActive>64</InActive>
  </CertificateTypesUpdate>
  <CertificateTypesUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <IssuerTypeID>64</IssuerTypeID>
    <Duration>1</Duration>
    <ExpiryReminder>64</ExpiryReminder>
    <RequiresProperty>64</RequiresProperty>
    <AllowOnlyOneActive>64</AllowOnlyOneActive>
    <RequiresRentalIntroductions>64</RequiresRentalIntroductions>
    <RequiresRentalRentCollect>64</RequiresRentalRentCollect>
    <RequiresRentalFullManagement>64</RequiresRentalFullManagement>
    <RequiresHMO>64</RequiresHMO>
    <RequiresGas>64</RequiresGas>
    <RequiresElectric>64</RequiresElectric>
    <RequiresOpenFireStove>64</RequiresOpenFireStove>
    <ShowAsReminder>64</ShowAsReminder>
    <OrderAction>64</OrderAction>
    <SendToOwner>64</SendToOwner>
    <SendToTenant>64</SendToTenant>
    <InActive>64</InActive>
  </CertificateTypesUpdate>
</ArrayOfCertificateTypesUpdate>