POST v1/Tasks/UpdateProgress
Updates task to specified percent complete.
Request Information
URI Parameters
None.
Body Parameters
Task to be updated
TaskDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Subject | string |
None. |
|
| Description | string |
None. |
|
| StartDate | string |
None. |
|
| DueDate | string |
None. |
|
| CompletedDate | string |
None. |
|
| Status | string |
None. |
|
| Priority | string |
None. |
|
| AssignedContactId | integer |
None. |
|
| Complete | string |
None. |
|
| ReminderOn | boolean |
None. |
|
| AlertOn | boolean |
None. |
|
| CreatedBy | integer |
None. |
|
| CreatedOn | string |
None. |
|
| ReminderDate | string |
None. |
|
| ModifyBy | integer |
None. |
|
| ModifyOn | string |
None. |
|
| CreatedBySearchable | string |
None. |
|
| PolicyNos | string |
None. |
|
| AssignedPolicyIDs | Collection of integer |
None. |
|
| PriorityOrder | integer |
None. |
|
| NotificationReminders | Collection of NotificationReminderDTO |
None. |
|
| AssignedEmployeeIDs | Collection of integer |
None. |
|
| AssignedContactName | string |
None. |
|
| OfficeEmployeeIDs | string |
None. |
|
| OfficeEmployeeNames | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"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": "f8e049dd-b25c-4878-b910-dcba28d55b53",
"TaskId": 2,
"UserId": 1
},
{
"NotificationId": "f8e049dd-b25c-4878-b910-dcba28d55b53",
"TaskId": 2,
"UserId": 1
}
],
"AssignedEmployeeIDs": [
1,
2
],
"AssignedContactName": "sample string 19",
"OfficeEmployeeIDs": "sample string 20",
"OfficeEmployeeNames": "sample string 21"
}
application/xml, text/xml
Sample:
<TaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
<AlertOn>true</AlertOn>
<AssignedContactId>1</AssignedContactId>
<AssignedContactName>sample string 19</AssignedContactName>
<AssignedEmployeeIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</AssignedEmployeeIDs>
<AssignedPolicyIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</AssignedPolicyIDs>
<Complete>sample string 9</Complete>
<CompletedDate>sample string 6</CompletedDate>
<CreatedBy>12</CreatedBy>
<CreatedBySearchable>sample string 17</CreatedBySearchable>
<CreatedOn>sample string 13</CreatedOn>
<Description>sample string 3</Description>
<DueDate>sample string 5</DueDate>
<Id>1</Id>
<ModifyBy>15</ModifyBy>
<ModifyOn>sample string 16</ModifyOn>
<NotificationReminders>
<NotificationReminderDTO>
<NotificationId>f8e049dd-b25c-4878-b910-dcba28d55b53</NotificationId>
<TaskId>2</TaskId>
<UserId>1</UserId>
</NotificationReminderDTO>
<NotificationReminderDTO>
<NotificationId>f8e049dd-b25c-4878-b910-dcba28d55b53</NotificationId>
<TaskId>2</TaskId>
<UserId>1</UserId>
</NotificationReminderDTO>
</NotificationReminders>
<OfficeEmployeeIDs>sample string 20</OfficeEmployeeIDs>
<OfficeEmployeeNames>sample string 21</OfficeEmployeeNames>
<PolicyNos>sample string 18</PolicyNos>
<Priority>sample string 8</Priority>
<ReminderDate>sample string 14</ReminderDate>
<ReminderOn>true</ReminderOn>
<StartDate>sample string 4</StartDate>
<Status>sample string 7</Status>
<Subject>sample string 2</Subject>
</TaskDTO>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Action result
ActionResultDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | boolean |
None. |
|
| ErrorCode | string |
None. |
|
| ErrorMessage | string |
None. |
|
| InfoMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccess": true,
"ErrorCode": "sample string 2",
"ErrorMessage": "sample string 3",
"InfoMessage": "sample string 4"
}
application/xml, text/xml
Sample:
<ActionResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects"> <ErrorCode>sample string 2</ErrorCode> <ErrorMessage>sample string 3</ErrorMessage> <InfoMessage>sample string 4</InfoMessage> <IsSuccess>true</IsSuccess> </ActionResultDTO>