POST 17.0/app/certificates/list

Description

Gets a list of Certificates that match the passed filters

URI Parameters

None.

Filters to retrieve Certificates for

CertificateListFilters
Name Description Type Additional information
Branches

Collection of integer

None.
Types

Collection of integer

None.
Status

CertificateListStatus

None.
OnlyCurrentContactsAndProperties

boolean

None.

application/json, text/json
Sample: 
{
  "branches": [
    1,
    2
  ],
  "types": [
    1,
    2
  ],
  "status": 0,
  "onlyCurrentContactsAndProperties": true
}

application/xml, text/xml
Sample: 
<CertificateListFilters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Branches>
    <int>1</int>
    <int>2</int>
  </Branches>
  <Types>
    <int>1</int>
    <int>2</int>
  </Types>
  <Status>All</Status>
  <OnlyCurrentContactsAndProperties>true</OnlyCurrentContactsAndProperties>
</CertificateListFilters>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of CertificateListItem
Name Description Type Additional information
Contact

CertificateContact

None.
Property

IDDescriptionPair

None.
Id

integer

None.
Status

IDDescriptionPair

None.
Type

IDDescriptionPair

None.
StartDate

date

None.
ExpiryDate

date

None.
DaysLeft

integer

None.
Issuer

IDDescriptionPair

None.
Reference

string

None.
DaysSinceUpdated

integer

None.
Rating

string

None.

application/json, text/json
Sample: 
[
  {
    "contact": {
      "id": 1,
      "description": "sample string 2",
      "email": "sample string 3",
      "mobile": "sample string 4",
      "marketingPreferences": {
        "post": true,
        "email": true,
        "smsText": true,
        "telephone": true,
        "passDetailsToThirdParties": true,
        "passDetailsToIFA": true,
        "passDetailsToConveyancer": true
      }
    },
    "property": {
      "id": 1,
      "description": "sample string 2"
    },
    "id": 1,
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "startDate": "2025-01-09T20:16",
    "expiryDate": "2025-01-09T20:16",
    "daysLeft": 4,
    "issuer": {
      "id": 1,
      "description": "sample string 2"
    },
    "reference": "sample string 5",
    "daysSinceUpdated": 6,
    "rating": "sample string 7"
  },
  {
    "contact": {
      "id": 1,
      "description": "sample string 2",
      "email": "sample string 3",
      "mobile": "sample string 4",
      "marketingPreferences": {
        "post": true,
        "email": true,
        "smsText": true,
        "telephone": true,
        "passDetailsToThirdParties": true,
        "passDetailsToIFA": true,
        "passDetailsToConveyancer": true
      }
    },
    "property": {
      "id": 1,
      "description": "sample string 2"
    },
    "id": 1,
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "startDate": "2025-01-09T20:16",
    "expiryDate": "2025-01-09T20:16",
    "daysLeft": 4,
    "issuer": {
      "id": 1,
      "description": "sample string 2"
    },
    "reference": "sample string 5",
    "daysSinceUpdated": 6,
    "rating": "sample string 7"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfCertificateListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CertificateListItem>
    <Id>1</Id>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <StartDate>2025-01-09T20:16:15.1101309+00:00</StartDate>
    <ExpiryDate>2025-01-09T20:16:15.1101309+00:00</ExpiryDate>
    <DaysLeft>4</DaysLeft>
    <Issuer>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Issuer>
    <Reference>sample string 5</Reference>
    <DaysSinceUpdated>6</DaysSinceUpdated>
    <Rating>sample string 7</Rating>
    <Contact>
      <ID>1</ID>
      <Description>sample string 2</Description>
      <Email>sample string 3</Email>
      <Mobile>sample string 4</Mobile>
      <MarketingPreferences>
        <Post>true</Post>
        <Email>true</Email>
        <SmsText>true</SmsText>
        <Telephone>true</Telephone>
        <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
        <PassDetailsToIFA>true</PassDetailsToIFA>
        <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
      </MarketingPreferences>
    </Contact>
    <Property>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Property>
  </CertificateListItem>
  <CertificateListItem>
    <Id>1</Id>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <StartDate>2025-01-09T20:16:15.1101309+00:00</StartDate>
    <ExpiryDate>2025-01-09T20:16:15.1101309+00:00</ExpiryDate>
    <DaysLeft>4</DaysLeft>
    <Issuer>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Issuer>
    <Reference>sample string 5</Reference>
    <DaysSinceUpdated>6</DaysSinceUpdated>
    <Rating>sample string 7</Rating>
    <Contact>
      <ID>1</ID>
      <Description>sample string 2</Description>
      <Email>sample string 3</Email>
      <Mobile>sample string 4</Mobile>
      <MarketingPreferences>
        <Post>true</Post>
        <Email>true</Email>
        <SmsText>true</SmsText>
        <Telephone>true</Telephone>
        <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
        <PassDetailsToIFA>true</PassDetailsToIFA>
        <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
      </MarketingPreferences>
    </Contact>
    <Property>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Property>
  </CertificateListItem>
</ArrayOfCertificateListItem>