POST api/property/{id}/certificate/add

Add certificate for a property

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The property id

integer

Required

Body Parameters

A certificate to add

PropertyCertificateAddDataContract
NameDescriptionTypeAdditional information
Name

string

None.

CertificateType

EnumDataContract

None.

StartDate

date

None.

ExpiryDate

date

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "CertificateType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "StartDate": "2025-07-01T22:31:29.8918541Z",
  "ExpiryDate": "2025-07-01T22:31:29.8918541Z",
  "Id": 4
}

Response Information

Resource Description

Collection of PropertyCertificateDataContract
NameDescriptionTypeAdditional information
Name

string

None.

CertificateType

EnumDataContract

None.

Documents

Collection of DocumentDataContract

None.

StartDate

date

None.

ExpiryDate

date

None.

ReceivedDate

date

None.

Expired

boolean

None.

Status

string

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "CertificateType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Documents": [
      {
        "Url": "sample string 1",
        "RequiresAuthentication": true,
        "ExpiryDate": "2025-07-01T22:31:29.8918541Z",
        "FileStream": null,
        "Tags": [
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          },
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          }
        ],
        "ApprovalStatus": {
          "Status": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Reason": "sample string 1",
          "LastUpdatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 2
        },
        "DocumentType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "DocumentSubType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "FileExtension": "sample string 5",
        "Description": "sample string 6",
        "FileSize": "sample string 7",
        "CreatedDate": "2025-07-01T22:31:29.8918541Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 9
      },
      {
        "Url": "sample string 1",
        "RequiresAuthentication": true,
        "ExpiryDate": "2025-07-01T22:31:29.8918541Z",
        "FileStream": null,
        "Tags": [
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          },
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          }
        ],
        "ApprovalStatus": {
          "Status": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Reason": "sample string 1",
          "LastUpdatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 2
        },
        "DocumentType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "DocumentSubType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "FileExtension": "sample string 5",
        "Description": "sample string 6",
        "FileSize": "sample string 7",
        "CreatedDate": "2025-07-01T22:31:29.8918541Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 9
      }
    ],
    "StartDate": "2025-07-01T22:31:29.8918541Z",
    "ExpiryDate": "2025-07-01T22:31:29.8918541Z",
    "ReceivedDate": "2025-07-01T22:31:29.8918541Z",
    "Expired": true,
    "Status": "Expiring soon",
    "Id": 6
  },
  {
    "Name": "sample string 1",
    "CertificateType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Documents": [
      {
        "Url": "sample string 1",
        "RequiresAuthentication": true,
        "ExpiryDate": "2025-07-01T22:31:29.8918541Z",
        "FileStream": null,
        "Tags": [
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          },
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          }
        ],
        "ApprovalStatus": {
          "Status": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Reason": "sample string 1",
          "LastUpdatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 2
        },
        "DocumentType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "DocumentSubType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "FileExtension": "sample string 5",
        "Description": "sample string 6",
        "FileSize": "sample string 7",
        "CreatedDate": "2025-07-01T22:31:29.8918541Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 9
      },
      {
        "Url": "sample string 1",
        "RequiresAuthentication": true,
        "ExpiryDate": "2025-07-01T22:31:29.8918541Z",
        "FileStream": null,
        "Tags": [
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          },
          {
            "Name": "sample string 1",
            "SystemStatusName": "sample string 2",
            "TagType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 3
          }
        ],
        "ApprovalStatus": {
          "Status": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Reason": "sample string 1",
          "LastUpdatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 2
        },
        "DocumentType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "DocumentSubType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "FileExtension": "sample string 5",
        "Description": "sample string 6",
        "FileSize": "sample string 7",
        "CreatedDate": "2025-07-01T22:31:29.8918541Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 9
      }
    ],
    "StartDate": "2025-07-01T22:31:29.8918541Z",
    "ExpiryDate": "2025-07-01T22:31:29.8918541Z",
    "ReceivedDate": "2025-07-01T22:31:29.8918541Z",
    "Expired": true,
    "Status": "Expiring soon",
    "Id": 6
  }
]