GET v1/Employees/{employeeID}/Tasks?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}
Gets the tasks assigned to an employee
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| employeeID |
Id of the employee |
integer |
Required |
| pageNumber |
Page Number |
integer |
Default value is 1 |
| pageSize |
Page Size |
integer |
Default value is 25 |
| orderBy |
Order By |
string |
None. |
| orderDirection |
Order Direction |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Paged list of tasks
PageOfOfTaskDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of TaskDTO |
None. |
|
| PageNumber | integer |
None. |
|
| PagesTotal | integer |
None. |
|
| TotalItems | integer |
None. |
|
| IsSuccess | boolean |
None. |
|
| ErrorCode | string |
None. |
|
| ErrorMessage | string |
None. |
|
| DisplayMessage | string |
None. |
|
| Links | Collection of PageLink |
None. |
|
| Href | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"Id": 1,
"Subject": "sample string 2",
"Description": "sample string 3",
"StartDate": "sample string 4",
"DueDate": "sample string 5",
"CompletedDate": "sample string 6",
"Status": "sample string 7",
"Priority": "sample string 8",
"AssignedContactId": 1,
"Complete": "sample string 9",
"ReminderOn": true,
"AlertOn": true,
"CreatedBy": 12,
"CreatedOn": "sample string 13",
"ReminderDate": "sample string 14",
"ModifyBy": 15,
"ModifyOn": "sample string 16",
"CreatedBySearchable": "sample string 17",
"PolicyNos": "sample string 18",
"AssignedPolicyIDs": [
1,
2
],
"PriorityOrder": 0,
"NotificationReminders": [
{
"NotificationId": "87634eef-3eea-430f-ab7a-98c5cb16ec7b",
"TaskId": 2,
"UserId": 1
},
{
"NotificationId": "87634eef-3eea-430f-ab7a-98c5cb16ec7b",
"TaskId": 2,
"UserId": 1
}
],
"AssignedEmployeeIDs": [
1,
2
],
"AssignedContactName": "sample string 19",
"OfficeEmployeeIDs": "sample string 20",
"OfficeEmployeeNames": "sample string 21"
},
{
"Id": 1,
"Subject": "sample string 2",
"Description": "sample string 3",
"StartDate": "sample string 4",
"DueDate": "sample string 5",
"CompletedDate": "sample string 6",
"Status": "sample string 7",
"Priority": "sample string 8",
"AssignedContactId": 1,
"Complete": "sample string 9",
"ReminderOn": true,
"AlertOn": true,
"CreatedBy": 12,
"CreatedOn": "sample string 13",
"ReminderDate": "sample string 14",
"ModifyBy": 15,
"ModifyOn": "sample string 16",
"CreatedBySearchable": "sample string 17",
"PolicyNos": "sample string 18",
"AssignedPolicyIDs": [
1,
2
],
"PriorityOrder": 0,
"NotificationReminders": [
{
"NotificationId": "87634eef-3eea-430f-ab7a-98c5cb16ec7b",
"TaskId": 2,
"UserId": 1
},
{
"NotificationId": "87634eef-3eea-430f-ab7a-98c5cb16ec7b",
"TaskId": 2,
"UserId": 1
}
],
"AssignedEmployeeIDs": [
1,
2
],
"AssignedContactName": "sample string 19",
"OfficeEmployeeIDs": "sample string 20",
"OfficeEmployeeNames": "sample string 21"
}
],
"PageNumber": 1,
"PagesTotal": 2,
"TotalItems": 3,
"IsSuccess": true,
"ErrorCode": "sample string 5",
"ErrorMessage": "sample string 6",
"DisplayMessage": "sample string 7",
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2"
},
{
"Rel": "sample string 1",
"Href": "sample string 2"
}
],
"Href": "sample string 8"
}
application/xml, text/xml
Sample:
<PageOfTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
<d2p1:TaskDTO>
<d2p1:AlertOn>true</d2p1:AlertOn>
<d2p1:AssignedContactId>1</d2p1:AssignedContactId>
<d2p1:AssignedContactName>sample string 19</d2p1:AssignedContactName>
<d2p1:AssignedEmployeeIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d2p1:AssignedEmployeeIDs>
<d2p1:AssignedPolicyIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d2p1:AssignedPolicyIDs>
<d2p1:Complete>sample string 9</d2p1:Complete>
<d2p1:CompletedDate>sample string 6</d2p1:CompletedDate>
<d2p1:CreatedBy>12</d2p1:CreatedBy>
<d2p1:CreatedBySearchable>sample string 17</d2p1:CreatedBySearchable>
<d2p1:CreatedOn>sample string 13</d2p1:CreatedOn>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:DueDate>sample string 5</d2p1:DueDate>
<d2p1:Id>1</d2p1:Id>
<d2p1:ModifyBy>15</d2p1:ModifyBy>
<d2p1:ModifyOn>sample string 16</d2p1:ModifyOn>
<d2p1:NotificationReminders>
<d2p1:NotificationReminderDTO>
<d2p1:NotificationId>87634eef-3eea-430f-ab7a-98c5cb16ec7b</d2p1:NotificationId>
<d2p1:TaskId>2</d2p1:TaskId>
<d2p1:UserId>1</d2p1:UserId>
</d2p1:NotificationReminderDTO>
<d2p1:NotificationReminderDTO>
<d2p1:NotificationId>87634eef-3eea-430f-ab7a-98c5cb16ec7b</d2p1:NotificationId>
<d2p1:TaskId>2</d2p1:TaskId>
<d2p1:UserId>1</d2p1:UserId>
</d2p1:NotificationReminderDTO>
</d2p1:NotificationReminders>
<d2p1:OfficeEmployeeIDs>sample string 20</d2p1:OfficeEmployeeIDs>
<d2p1:OfficeEmployeeNames>sample string 21</d2p1:OfficeEmployeeNames>
<d2p1:PolicyNos>sample string 18</d2p1:PolicyNos>
<d2p1:Priority>sample string 8</d2p1:Priority>
<d2p1:ReminderDate>sample string 14</d2p1:ReminderDate>
<d2p1:ReminderOn>true</d2p1:ReminderOn>
<d2p1:StartDate>sample string 4</d2p1:StartDate>
<d2p1:Status>sample string 7</d2p1:Status>
<d2p1:Subject>sample string 2</d2p1:Subject>
</d2p1:TaskDTO>
<d2p1:TaskDTO>
<d2p1:AlertOn>true</d2p1:AlertOn>
<d2p1:AssignedContactId>1</d2p1:AssignedContactId>
<d2p1:AssignedContactName>sample string 19</d2p1:AssignedContactName>
<d2p1:AssignedEmployeeIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d2p1:AssignedEmployeeIDs>
<d2p1:AssignedPolicyIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d2p1:AssignedPolicyIDs>
<d2p1:Complete>sample string 9</d2p1:Complete>
<d2p1:CompletedDate>sample string 6</d2p1:CompletedDate>
<d2p1:CreatedBy>12</d2p1:CreatedBy>
<d2p1:CreatedBySearchable>sample string 17</d2p1:CreatedBySearchable>
<d2p1:CreatedOn>sample string 13</d2p1:CreatedOn>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:DueDate>sample string 5</d2p1:DueDate>
<d2p1:Id>1</d2p1:Id>
<d2p1:ModifyBy>15</d2p1:ModifyBy>
<d2p1:ModifyOn>sample string 16</d2p1:ModifyOn>
<d2p1:NotificationReminders>
<d2p1:NotificationReminderDTO>
<d2p1:NotificationId>87634eef-3eea-430f-ab7a-98c5cb16ec7b</d2p1:NotificationId>
<d2p1:TaskId>2</d2p1:TaskId>
<d2p1:UserId>1</d2p1:UserId>
</d2p1:NotificationReminderDTO>
<d2p1:NotificationReminderDTO>
<d2p1:NotificationId>87634eef-3eea-430f-ab7a-98c5cb16ec7b</d2p1:NotificationId>
<d2p1:TaskId>2</d2p1:TaskId>
<d2p1:UserId>1</d2p1:UserId>
</d2p1:NotificationReminderDTO>
</d2p1:NotificationReminders>
<d2p1:OfficeEmployeeIDs>sample string 20</d2p1:OfficeEmployeeIDs>
<d2p1:OfficeEmployeeNames>sample string 21</d2p1:OfficeEmployeeNames>
<d2p1:PolicyNos>sample string 18</d2p1:PolicyNos>
<d2p1:Priority>sample string 8</d2p1:Priority>
<d2p1:ReminderDate>sample string 14</d2p1:ReminderDate>
<d2p1:ReminderOn>true</d2p1:ReminderOn>
<d2p1:StartDate>sample string 4</d2p1:StartDate>
<d2p1:Status>sample string 7</d2p1:Status>
<d2p1:Subject>sample string 2</d2p1:Subject>
</d2p1:TaskDTO>
</Data>
<DisplayMessage>sample string 7</DisplayMessage>
<ErrorCode>sample string 5</ErrorCode>
<ErrorMessage>sample string 6</ErrorMessage>
<Href>sample string 8</Href>
<IsSuccess>true</IsSuccess>
<Links>
<PageLink>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
</PageLink>
<PageLink>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
</PageLink>
</Links>
<PageNumber>1</PageNumber>
<PagesTotal>2</PagesTotal>
<TotalItems>3</TotalItems>
</PageOfTaskDTO>