POST api/list/todotasks?pageSize={pageSize}&pageNumber={pageNumber}
Get list of todos tasks.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
pageSize | integer |
Default value is 20 |
|
pageNumber | integer |
Default value is 1 |
Body Parameters
Dezrez.Core.DataContracts.External.Api.Lists.Todos.Filter.TodoTaskListFilterDataContractName | Description | Type | Additional information |
---|---|---|---|
Statuses | Collection of string |
None. |
|
Schedules | Collection of string |
None. |
|
NegotiatorIds | Collection of integer |
None. |
|
TodoIds | Collection of integer |
None. |
|
Ids | Collection of integer |
None. |
|
DateFrom | date |
None. |
|
DateTo | date |
None. |
|
Date | Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract |
None. |
|
Sort | Dezrez.Core.DataContracts.External.Api.Lists.Todos.TodoListSort |
None. |
|
OwningNegotiatorId | integer |
None. |
|
ClaimedNegotiatorId | integer |
None. |
|
IsOverdueOnly | boolean |
None. |
|
Name | string |
None. |
|
CustomFilterConfig | string |
None. |
|
BranchId | integer |
None. |
|
BranchIds | Collection of integer |
None. |
|
EventBranchIds | Collection of integer |
None. |
|
Order | Dezrez.Core.DataContracts.External.Api.Lists.ListOrder |
None. |
|
SearchTerm | string |
None. |
|
FilterType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
ShowDeleted | boolean |
None. |
|
ShowCancelled | boolean |
None. |
|
OwningTeamId | integer |
None. |
|
Id | integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{ "Statuses": [ "sample string 1", "sample string 2" ], "Schedules": [ "sample string 1", "sample string 2" ], "NegotiatorIds": [ 1, 2 ], "TodoIds": [ 1, 2 ], "Ids": [ 1, 2 ], "DateFrom": "2024-10-05T04:46:43.0235761Z", "DateTo": "2024-10-05T04:46:43.0235761Z", "Date": { "FromStaticDate": "2024-10-05T04:46:43.0235761Z", "ToStaticDate": "2024-10-05T04:46:43.0235761Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "Sort": 0, "OwningNegotiatorId": 1, "ClaimedNegotiatorId": 1, "IsOverdueOnly": true, "Name": "sample string 2", "CustomFilterConfig": "sample string 3", "BranchId": 1, "BranchIds": [ 1, 2 ], "EventBranchIds": [ 1, 2 ], "Order": 0, "SearchTerm": "sample string 4", "FilterType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ShowDeleted": true, "ShowCancelled": true, "OwningTeamId": 7, "Id": 8 }
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Todos.TaskListDataContractName | 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.Todos.TaskListDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalCount": 1, "CurrentCount": 2, "PageSize": 1, "PageNumber": 1, "Collection": [ { "ToDoId": 1, "DueDate": "2024-10-05T04:46:43.0235761Z", "StatusType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TaskType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Priority": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ScheduleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ClaimedNegotiator": { "ContactName": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 5", "Id": 6 }, "TaskInfo": { "Id": 1, "Name": "sample string 2", "Description": "sample string 3" }, "Id": 3 }, { "ToDoId": 1, "DueDate": "2024-10-05T04:46:43.0235761Z", "StatusType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TaskType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Priority": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ScheduleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ClaimedNegotiator": { "ContactName": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 5", "Id": 6 }, "TaskInfo": { "Id": 1, "Name": "sample string 2", "Description": "sample string 3" }, "Id": 3 } ] }