POST v1/Tasks

Insert a task

Request Information

URI Parameters

None.

Body Parameters

Task to be inserted

Name	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": "91957abb-6942-4881-be25-6cfa356b3547",
      "TaskId": 2,
      "UserId": 1
    },
    {
      "NotificationId": "91957abb-6942-4881-be25-6cfa356b3547",
      "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>91957abb-6942-4881-be25-6cfa356b3547</NotificationId>
      <TaskId>2</TaskId>
      <UserId>1</UserId>
    </NotificationReminderDTO>
    <NotificationReminderDTO>
      <NotificationId>91957abb-6942-4881-be25-6cfa356b3547</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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TaskDTO'.

Response Information

Resource Description

Inserted task

ActionResultDTOOfTaskDTO

Name	Type	Additional information
Result	TaskDTO	None.
CreatedBy	string	None.
EntityID	integer	None.
RowSource	string	None.
PolicyID	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
InfoMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "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": [
      {
        "NotificationId": "fd33d66d-6a4a-4736-9f96-ed341ff3d757",
        "TaskId": 2,
        "UserId": 1
      },
      {
        "NotificationId": "fd33d66d-6a4a-4736-9f96-ed341ff3d757",
        "TaskId": 2,
        "UserId": 1
      }
    ],
    "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

Sample:

<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>
      <d2p1:NotificationReminderDTO>
        <d2p1:NotificationId>fd33d66d-6a4a-4736-9f96-ed341ff3d757</d2p1:NotificationId>
        <d2p1:TaskId>2</d2p1:TaskId>
        <d2p1:UserId>1</d2p1:UserId>
      </d2p1:NotificationReminderDTO>
      <d2p1:NotificationReminderDTO>
        <d2p1:NotificationId>fd33d66d-6a4a-4736-9f96-ed341ff3d757</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>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfTaskDTO>