PUT v1/Tasks/{taskID}/UpdateTask
Updates an existing task
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| taskID |
Id of the task to update |
integer |
Required |
Body Parameters
Task data to be updated
TaskUpdateDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id of the task |
integer |
None. |
| Subject |
Subject of the task |
string |
None. |
| Description |
Description of the task |
string |
None. |
| StartDate |
Start date |
string |
None. |
| DueDate |
Due date |
string |
None. |
| CompletedDate |
Completed date |
string |
None. |
| ReminderDate |
Reminder date |
string |
None. |
| Status |
Status of the task |
string |
None. |
| Priority |
Priority of the task |
string |
None. |
| AssignedContactId |
Id of the assigned contact |
integer |
None. |
| Complete |
Complete |
string |
None. |
| ReminderOn |
Signifies whether the reminder is on |
boolean |
None. |
| AlertOn |
Signifies whether the alert is on |
boolean |
None. |
| AssignedPolicyIDs |
Assigned policy ids |
Collection of integer |
None. |
| AssignedEmployeeIDs |
Assigned employee ids |
Collection of integer |
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",
"ReminderDate": "sample string 7",
"Status": "sample string 8",
"Priority": "sample string 9",
"AssignedContactId": 1,
"Complete": "sample string 10",
"ReminderOn": true,
"AlertOn": true,
"AssignedPolicyIDs": [
1,
2
],
"AssignedEmployeeIDs": [
1,
2
]
}
application/x-www-form-urlencoded
Sample:
application/xml, text/xml
Sample:
<TaskUpdateDTO 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>
<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 10</Complete>
<CompletedDate>sample string 6</CompletedDate>
<Description>sample string 3</Description>
<DueDate>sample string 5</DueDate>
<Id>1</Id>
<Priority>sample string 9</Priority>
<ReminderDate>sample string 7</ReminderDate>
<ReminderOn>true</ReminderOn>
<StartDate>sample string 4</StartDate>
<Status>sample string 8</Status>
<Subject>sample string 2</Subject>
</TaskUpdateDTO>
Response Information
Resource Description
Action result
ActionResultDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess |
Signifies whether action is successful |
boolean |
None. |
| ErrorCode |
Error code |
string |
None. |
| ErrorMessage |
Error message |
string |
None. |
| InfoMessage |
Information message |
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>