POST 17.0/database/certificates/list

Description

Retrieve a list of Certificates

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 CertificatesUpdate
Name Description Type Additional information
ID

integer

None.
ContactID

integer

None.
PropertyID

integer

None.
IssuerID

integer

None.
CertificateTypeID

integer

None.
UserID

integer

None.
AddedDate

date

None.
UpdatedDate

date

None.
Reference

string

String length: inclusive between 0 and 30
StartDate

date

None.
EndDate

date

None.
Status

byte

None.
EERCurrent

decimal number

None.
EERPotential

decimal number

None.
EIRCurrent

decimal number

None.
EIRPotential

decimal number

None.
EERCurrentMin

decimal number

None.
EERPotentialMin

decimal number

None.
EIRCurrentMin

decimal number

None.
EIRPotentialMin

decimal number

None.
UploadPDF

byte

None.
InActive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "issuerID": 1,
    "certificateTypeID": 1,
    "userID": 1,
    "addedDate": "2025-01-09T20:36",
    "updatedDate": "2025-01-09T20:36",
    "reference": "sample string 1",
    "startDate": "2025-01-09T20:36",
    "endDate": "2025-01-09T20:36",
    "status": 64,
    "eerCurrent": 1.0,
    "eerPotential": 1.0,
    "eirCurrent": 1.0,
    "eirPotential": 1.0,
    "eerCurrentMin": 1.0,
    "eerPotentialMin": 1.0,
    "eirCurrentMin": 1.0,
    "eirPotentialMin": 1.0,
    "uploadPDF": 64,
    "inActive": 64
  },
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "issuerID": 1,
    "certificateTypeID": 1,
    "userID": 1,
    "addedDate": "2025-01-09T20:36",
    "updatedDate": "2025-01-09T20:36",
    "reference": "sample string 1",
    "startDate": "2025-01-09T20:36",
    "endDate": "2025-01-09T20:36",
    "status": 64,
    "eerCurrent": 1.0,
    "eerPotential": 1.0,
    "eirCurrent": 1.0,
    "eirPotential": 1.0,
    "eerCurrentMin": 1.0,
    "eerPotentialMin": 1.0,
    "eirCurrentMin": 1.0,
    "eirPotentialMin": 1.0,
    "uploadPDF": 64,
    "inActive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfCertificatesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CertificatesUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <IssuerID>1</IssuerID>
    <CertificateTypeID>1</CertificateTypeID>
    <UserID>1</UserID>
    <AddedDate>2025-01-09T20:36:20.8438419+00:00</AddedDate>
    <UpdatedDate>2025-01-09T20:36:20.8438419+00:00</UpdatedDate>
    <Reference>sample string 1</Reference>
    <StartDate>2025-01-09T20:36:20.8438419+00:00</StartDate>
    <EndDate>2025-01-09T20:36:20.8438419+00:00</EndDate>
    <Status>64</Status>
    <EERCurrent>1</EERCurrent>
    <EERPotential>1</EERPotential>
    <EIRCurrent>1</EIRCurrent>
    <EIRPotential>1</EIRPotential>
    <EERCurrentMin>1</EERCurrentMin>
    <EERPotentialMin>1</EERPotentialMin>
    <EIRCurrentMin>1</EIRCurrentMin>
    <EIRPotentialMin>1</EIRPotentialMin>
    <UploadPDF>64</UploadPDF>
    <InActive>64</InActive>
  </CertificatesUpdate>
  <CertificatesUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <IssuerID>1</IssuerID>
    <CertificateTypeID>1</CertificateTypeID>
    <UserID>1</UserID>
    <AddedDate>2025-01-09T20:36:20.8438419+00:00</AddedDate>
    <UpdatedDate>2025-01-09T20:36:20.8438419+00:00</UpdatedDate>
    <Reference>sample string 1</Reference>
    <StartDate>2025-01-09T20:36:20.8438419+00:00</StartDate>
    <EndDate>2025-01-09T20:36:20.8438419+00:00</EndDate>
    <Status>64</Status>
    <EERCurrent>1</EERCurrent>
    <EERPotential>1</EERPotential>
    <EIRCurrent>1</EIRCurrent>
    <EIRPotential>1</EIRPotential>
    <EERCurrentMin>1</EERCurrentMin>
    <EERPotentialMin>1</EERPotentialMin>
    <EIRCurrentMin>1</EIRCurrentMin>
    <EIRPotentialMin>1</EIRPotentialMin>
    <UploadPDF>64</UploadPDF>
    <InActive>64</InActive>
  </CertificatesUpdate>
</ArrayOfCertificatesUpdate>