POST api/list/pm/appointments

Returns a list of Appointments in PM

Request Information

URI Parameters

None.

Body Parameters

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.

PageSize

integer

None.

PageNumber

integer

None.

Term

string

None.

OrderByDescending

boolean

None.

Name

string

None.

Request Formats

application/json, text/json

Sample:
{
  "StartDateFrom": "2021-12-01T21:48:26.6225917Z",
  "StartDateTo": "2021-12-01T21:48:26.6225917Z",
  "Types": [
    "sample string 1",
    "sample string 2"
  ],
  "BranchIds": [
    1,
    2
  ],
  "AttendingNegotiatorIds": [
    1,
    2
  ],
  "Statuses": [
    "sample string 1",
    "sample string 2"
  ],
  "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

PagedCollectionDataContractOfAppointmentsListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of 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": "2021-12-01T21:48:26.6225917Z",
      "EndDate": "2021-12-01T21:48:26.6225917Z",
      "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": "2021-12-01T21:48:26.6225917Z",
      "EndDate": "2021-12-01T21:48:26.6225917Z",
      "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"
        }
      ]
    }
  ]
}