POST api/list/pm/certificatesandlicences
Request Information
URI Parameters
None.
Body Parameters
Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmCertificatesAndLicencesListFilterDataContractName | 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. |
|
Sort | Dezrez.Core.DataContracts.External.Api.Lists.PmLists.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": "2024-10-04T18:58:52.0975974Z", "ExpiryDateTo": "2024-10-04T18:58:52.0975974Z", "TeamGroupIds": [ 1, 2 ], "CertificateTypes": [ "sample string 1", "sample string 2" ], "DocumentUploaded": true, "ServiceLevels": [ "sample string 1", "sample string 2" ], "IncludeActiveTenancies": true, "Sort": 1, "PageSize": 1, "PageNumber": 1, "Term": "sample string 1", "OrderByDescending": true, "Name": "sample string 2" }
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Tenancy.CertificatesAndLicencesListDataContractName | Description | Type | Additional information |
---|---|---|---|
TotalCount | integer |
None. |
|
CurrentCount | integer |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
Collection | Collection of Dezrez.Core.DataContracts.External.Api.Lists.Tenancy.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": "2024-10-04T18:58:52.0975974Z", "ExpiryDate": "2024-10-04T18:58:52.0975974Z", "ReceivedDate": "2024-10-04T18:58:52.0975974Z", "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": "2024-10-04T18:58:52.0975974Z", "ExpiryDate": "2024-10-04T18:58:52.0975974Z", "ReceivedDate": "2024-10-04T18:58:52.0975974Z", "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 } ] }