POST v1/Tasks
Insert a task
Request Information
URI Parameters
None.
Body Parameters
Task to be inserted
TaskDTO| 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. |
| 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. |
| CreatedBy |
Created by |
integer |
None. |
| CreatedOn |
Created on |
string |
None. |
| ReminderDate |
Reminder date |
string |
None. |
| ModifyBy |
Modify by |
integer |
None. |
| ModifyOn |
Modify on |
string |
None. |
| CreatedBySearchable |
Created By Searchable |
string |
None. |
| PolicyNos |
Actual Policies No |
string |
None. |
| AssignedPolicyIDs |
Assigned policy ids |
Collection of integer |
None. |
| PriorityOrder |
Priority order of the task |
integer |
None. |
| NotificationReminders |
List of notification reminders |
Collection of NotificationReminderDTO |
None. |
| AssignedEmployeeIDs |
Assigned employee ids |
Collection of integer |
None. |
| AssignedContactName |
Assigned Contact Name |
string |
None. |
| OfficeEmployeeIDs |
Office Employee IDs |
string |
None. |
| OfficeEmployeeNames |
Office Employee Names |
string |
None. |
Request Formats
application/json, text/json
{
"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": null,
"AssignedEmployeeIDs": [
1,
2
],
"AssignedContactName": "sample string 19",
"OfficeEmployeeIDs": "sample string 20",
"OfficeEmployeeNames": "sample string 21"
}
application/x-www-form-urlencoded
application/xml, text/xml
<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 i:nil="true" />
<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>
Response Information
Resource Description
Inserted task
ActionResultDTOOfTaskDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | TaskDTO |
None. |
|
| CreatedBy | string |
None. |
|
| EntityID | integer |
None. |
|
| RowSource | string |
None. |
|
| PolicyID | integer |
None. |
|
| 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
{
"Result": {
"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": null,
"AssignedEmployeeIDs": [
1,
2
],
"AssignedContactName": "sample string 19",
"OfficeEmployeeIDs": "sample string 20",
"OfficeEmployeeNames": "sample string 21"
},
"CreatedBy": "sample string 1",
"EntityID": 2,
"RowSource": "sample string 3",
"PolicyID": 4,
"IsSuccess": true,
"ErrorCode": "sample string 6",
"ErrorMessage": "sample string 7",
"InfoMessage": "sample string 8"
}
application/xml, text/xml
<ActionResultOfTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
<ErrorCode>sample string 6</ErrorCode>
<ErrorMessage>sample string 7</ErrorMessage>
<InfoMessage>sample string 8</InfoMessage>
<IsSuccess>true</IsSuccess>
<CreatedBy>sample string 1</CreatedBy>
<EntityID>2</EntityID>
<PolicyID>4</PolicyID>
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
<d2p1:AlertOn>true</d2p1:AlertOn>
<d2p1:AssignedContactId>1</d2p1:AssignedContactId>
<d2p1:AssignedContactName>sample string 19</d2p1:AssignedContactName>
<d2p1:AssignedEmployeeIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</d2p1:AssignedEmployeeIDs>
<d2p1:AssignedPolicyIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1: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 i:nil="true" />
<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>
</Result>
<RowSource>sample string 3</RowSource>
</ActionResultOfTaskDTO>