POST api/list/pm/appointments
Returns a list of Appointments in PM
Request Information
URI Parameters
None.
Body Parameters
PmAppointmentsListFilterDataContractName | Description | Type | Additional 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. |
|
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": "2023-02-06T03:27:14.3800813Z", "StartDateTo": "2023-02-06T03:27:14.3800813Z", "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" ], "PageSize": 1, "PageNumber": 1, "Term": "sample string 1", "OrderByDescending": true, "Name": "sample string 2" }
Response Information
Resource Description
PagedCollectionDataContractOfAppointmentsListDataContractName | Description | Type | Additional 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": "2023-02-06T03:27:14.3956972Z", "EndDate": "2023-02-06T03:27:14.3956972Z", "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": "2023-02-06T03:27:14.3956972Z", "EndDate": "2023-02-06T03:27:14.3956972Z", "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" } ] } ] }