POST api/list/pm/certificatesandlicences
Request Information
URI Parameters
None.
Body Parameters
PmCertificatesAndLicencesListFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| BranchIds | Collection of integer |
None. |
|
| ExpiryDateFrom | date |
None. |
|
| ExpiryDateTo | date |
None. |
|
| TeamGroupIds | Collection of integer |
None. |
|
| CertificateTypes | Collection of string |
None. |
|
| DocumentUploaded | boolean |
None. |
|
| ServiceLevels | Collection of string |
None. |
|
| IncludeActiveTenancies | boolean |
None. |
|
| LatestCertificatesOnly | boolean |
None. |
|
| Sort | PmCertificatesAndLicencesListSort |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Term | string |
None. |
|
| OrderByDescending | boolean |
None. |
|
| Name | string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"BranchIds": [
1,
2
],
"ExpiryDateFrom": "2025-11-18T14:07:01.5337234Z",
"ExpiryDateTo": "2025-11-18T14:07:01.5337234Z",
"TeamGroupIds": [
1,
2
],
"CertificateTypes": [
"sample string 1",
"sample string 2"
],
"DocumentUploaded": true,
"ServiceLevels": [
"sample string 1",
"sample string 2"
],
"IncludeActiveTenancies": true,
"LatestCertificatesOnly": true,
"Sort": 1,
"PageSize": 1,
"PageNumber": 1,
"Term": "sample string 1",
"OrderByDescending": true,
"Name": "sample string 2"
}
Response Information
Resource Description
PagedCollectionDataContractOfCertificatesAndLicencesListDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| CurrentCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Collection | Collection of CertificatesAndLicencesListDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"Id": 1,
"Name": "sample string 2",
"StartDate": "2025-11-18T14:07:01.5493467Z",
"ExpiryDate": "2025-11-18T14:07:01.5493467Z",
"ReceivedDate": "2025-11-18T14:07:01.5493467Z",
"CertificateType": "sample string 6",
"HasDocument": true,
"PropertyId": 8,
"Address": "sample string 9",
"ServiceLevel": "sample string 10",
"BranchId": 11,
"MaintenanceJobId": 12,
"Status": "sample string 13",
"BelongsToActiveTenancy": true
},
{
"Id": 1,
"Name": "sample string 2",
"StartDate": "2025-11-18T14:07:01.5493467Z",
"ExpiryDate": "2025-11-18T14:07:01.5493467Z",
"ReceivedDate": "2025-11-18T14:07:01.5493467Z",
"CertificateType": "sample string 6",
"HasDocument": true,
"PropertyId": 8,
"Address": "sample string 9",
"ServiceLevel": "sample string 10",
"BranchId": 11,
"MaintenanceJobId": 12,
"Status": "sample string 13",
"BelongsToActiveTenancy": true
}
]
}