POST api/list/pm/inspections

Returns a list of Inspections in PM from a particular Property

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmAppointmentsListFilterDataContract
NameDescriptionTypeAdditional information
StartDateFrom

date

None.

StartDateTo

date

None.

Types

Collection of string

None.

BranchIds

Collection of integer

None.

AttendingNegotiatorIds

Collection of integer

None.

Statuses

Collection of string

None.

ExcludeRoleStatuses

Collection of string

None.

TenantRoleId

integer

None.

Sort

Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmAppointmentsListSort

None.

GroupId

integer

None.

PropertyId

integer

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:
{
  "StartDateFrom": "2024-11-21T09:50:30.2516123Z",
  "StartDateTo": "2024-11-21T09:50:30.2516123Z",
  "Types": [
    "sample string 1",
    "sample string 2"
  ],
  "BranchIds": [
    1,
    2
  ],
  "AttendingNegotiatorIds": [
    1,
    2
  ],
  "Statuses": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeRoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "TenantRoleId": 1,
  "Sort": 0,
  "GroupId": 1,
  "PropertyId": 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.AppointmentsListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.Lists.Tenancy.AppointmentsListDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": "sample string 3",
      "AppointmentTypeSystemName": "sample string 4",
      "StartDate": "2024-11-21T09:50:30.2516123Z",
      "EndDate": "2024-11-21T09:50:30.2516123Z",
      "IsAllDay": true,
      "Attendees": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        }
      ],
      "Negotiators": [
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        },
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": "sample string 3",
      "AppointmentTypeSystemName": "sample string 4",
      "StartDate": "2024-11-21T09:50:30.2516123Z",
      "EndDate": "2024-11-21T09:50:30.2516123Z",
      "IsAllDay": true,
      "Attendees": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        }
      ],
      "Negotiators": [
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        },
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        }
      ]
    }
  ]
}