POST api/list/pm/certificatesandlicences

Request Information

URI Parameters

None.

Body Parameters

PmCertificatesAndLicencesListFilterDataContract
NameDescriptionTypeAdditional 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.

Sort

PmCertificatesAndLicencesListSort

None.

PageSize

integer

None.

PageNumber

integer

None.

Term

string

None.

OrderByDescending

boolean

None.

Name

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BranchIds": [
    1,
    2
  ],
  "ExpiryDateFrom": "2020-12-04T08:44:26.9652155Z",
  "ExpiryDateTo": "2020-12-04T08:44:26.9652155Z",
  "TeamGroupIds": [
    1,
    2
  ],
  "CertificateTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "DocumentUploaded": true,
  "ServiceLevels": [
    "sample string 1",
    "sample string 2"
  ],
  "Sort": 1,
  "PageSize": 1,
  "PageNumber": 1,
  "Term": "sample string 1",
  "OrderByDescending": true,
  "Name": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PagedCollectionDataContractOfCertificatesAndLicencesListDataContract
NameDescriptionTypeAdditional 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": "2020-12-04T08:44:26.9808434Z",
      "ExpiryDate": "2020-12-04T08:44:26.9808434Z",
      "ReceivedDate": "2020-12-04T08:44:26.9808434Z",
      "CertificateType": "sample string 6",
      "DocumentId": 7,
      "PropertyId": 8,
      "Address": "sample string 9",
      "ServiceLevel": "sample string 10",
      "BranchId": 11,
      "MaintenanceJobId": 12,
      "Status": "sample string 13"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "StartDate": "2020-12-04T08:44:26.9808434Z",
      "ExpiryDate": "2020-12-04T08:44:26.9808434Z",
      "ReceivedDate": "2020-12-04T08:44:26.9808434Z",
      "CertificateType": "sample string 6",
      "DocumentId": 7,
      "PropertyId": 8,
      "Address": "sample string 9",
      "ServiceLevel": "sample string 10",
      "BranchId": 11,
      "MaintenanceJobId": 12,
      "Status": "sample string 13"
    }
  ]
}