POST api/tasks/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TaskID	integer	None.
ExcludeManual	boolean	None.
Subject	string	None.
DefaultTask	integer	None.
TaskStatusID	integer	None.
TaskPriorityID	integer	None.
TaskTypeID	integer	None.
TaskCategoryID	integer	None.
ResponsibleID	integer	None.
JobID	integer	None.
AllocatedUserID	integer	None.
SupplierID	integer	None.
ClientID	integer	None.
BrokerCode	string	None.
BusinessPartnerCode	string	None.
ProductID	integer	None.
FromDueDt	date	None.
ToDueDt	date	None.
FromContractEndDt	date	None.
ToContractEndDt	date	None.
OverdueTask	boolean	None.
OrderBy	string	None.
PageIndex	integer	None.
PageSize	integer	None.
userTypeId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "TaskID": 1,
  "ExcludeManual": true,
  "Subject": "sample string 3",
  "DefaultTask": 4,
  "TaskStatusID": 5,
  "TaskPriorityID": 6,
  "TaskTypeID": 7,
  "TaskCategoryID": 8,
  "ResponsibleID": 9,
  "JobID": 10,
  "AllocatedUserID": 11,
  "SupplierID": 12,
  "ClientID": 13,
  "BrokerCode": "sample string 14",
  "BusinessPartnerCode": "sample string 15",
  "ProductID": 16,
  "FromDueDt": "2026-08-14T17:38:02.1439636+01:00",
  "ToDueDt": "2026-08-14T17:38:02.1439636+01:00",
  "FromContractEndDt": "2026-08-14T17:38:02.1439636+01:00",
  "ToContractEndDt": "2026-08-14T17:38:02.1439636+01:00",
  "OverdueTask": true,
  "OrderBy": "sample string 18",
  "PageIndex": 19,
  "PageSize": 20,
  "userTypeId": 21
}

application/xml, text/xml

Sample:

<TaskSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <AllocatedUserID>11</AllocatedUserID>
  <BrokerCode>sample string 14</BrokerCode>
  <BusinessPartnerCode>sample string 15</BusinessPartnerCode>
  <ClientID>13</ClientID>
  <DefaultTask>4</DefaultTask>
  <ExcludeManual>true</ExcludeManual>
  <FromContractEndDt>2026-08-14T17:38:02.1439636+01:00</FromContractEndDt>
  <FromDueDt>2026-08-14T17:38:02.1439636+01:00</FromDueDt>
  <JobID>10</JobID>
  <OrderBy>sample string 18</OrderBy>
  <OverdueTask>true</OverdueTask>
  <PageIndex>19</PageIndex>
  <PageSize>20</PageSize>
  <ProductID>16</ProductID>
  <ResponsibleID>9</ResponsibleID>
  <Subject>sample string 3</Subject>
  <SupplierID>12</SupplierID>
  <TaskCategoryID>8</TaskCategoryID>
  <TaskID>1</TaskID>
  <TaskPriorityID>6</TaskPriorityID>
  <TaskStatusID>5</TaskStatusID>
  <TaskTypeID>7</TaskTypeID>
  <ToContractEndDt>2026-08-14T17:38:02.1439636+01:00</ToContractEndDt>
  <ToDueDt>2026-08-14T17:38:02.1439636+01:00</ToDueDt>
  <userTypeId>21</userTypeId>
</TaskSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponseOfGridPageResultOfTaskListItemDto

Name	Type	Additional information
Data	GridPageResultOfTaskListItemDto	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "TotalRecords": 1,
    "PageIndex": 2,
    "PageSize": 3,
    "PageCount": 4,
    "Records": [
      {
        "TaskID": 1,
        "TaskStatusID": 2,
        "AllocatedUserID": 3,
        "TaskTypeID": 4,
        "TaskCategoryID": 5,
        "TaskPriorityID": 6,
        "ClientID": 7,
        "JobID": 8,
        "SupplierID": 9,
        "ResponsibleID": 10,
        "ProductID": 11,
        "StageID": 12,
        "StageTaskID": 13,
        "DefaultTask": 14,
        "AllowManualCompletion": 15,
        "ElecMeterID": 16,
        "GasMeterID": 17,
        "QueryID": 18,
        "ProspectID": 19,
        "EmployeeID": 20,
        "TaskStatus": 21,
        "Subject": "sample string 22",
        "DueDate": "2026-08-14T17:38:02.1449814+01:00",
        "Detail": "sample string 24",
        "CompletedDate": "2026-08-14T17:38:02.1449814+01:00",
        "Reference": "sample string 26",
        "CreatedDate": "2026-08-14T17:38:02.1449814+01:00",
        "UpdatedDate": "2026-08-14T17:38:02.1449814+01:00",
        "UpdatedBy": "sample string 29",
        "BusinessPartnerCode": "sample string 30",
        "BrokerCode": "sample string 31",
        "PrdName": "sample string 32",
        "ContractEndDate": "2026-08-14T17:38:02.1449814+01:00",
        "MPxN": "sample string 34",
        "Category": "sample string 35",
        "Priority": "sample string 36",
        "Resposible": "sample string 37",
        "Status": "sample string 38",
        "Allocated": "sample string 39",
        "Stage": "sample string 40",
        "Id": 41,
        "TaskType": "sample string 42",
        "ActionCount": 43,
        "ClientName": "sample string 44"
      },
      {
        "TaskID": 1,
        "TaskStatusID": 2,
        "AllocatedUserID": 3,
        "TaskTypeID": 4,
        "TaskCategoryID": 5,
        "TaskPriorityID": 6,
        "ClientID": 7,
        "JobID": 8,
        "SupplierID": 9,
        "ResponsibleID": 10,
        "ProductID": 11,
        "StageID": 12,
        "StageTaskID": 13,
        "DefaultTask": 14,
        "AllowManualCompletion": 15,
        "ElecMeterID": 16,
        "GasMeterID": 17,
        "QueryID": 18,
        "ProspectID": 19,
        "EmployeeID": 20,
        "TaskStatus": 21,
        "Subject": "sample string 22",
        "DueDate": "2026-08-14T17:38:02.1449814+01:00",
        "Detail": "sample string 24",
        "CompletedDate": "2026-08-14T17:38:02.1449814+01:00",
        "Reference": "sample string 26",
        "CreatedDate": "2026-08-14T17:38:02.1449814+01:00",
        "UpdatedDate": "2026-08-14T17:38:02.1449814+01:00",
        "UpdatedBy": "sample string 29",
        "BusinessPartnerCode": "sample string 30",
        "BrokerCode": "sample string 31",
        "PrdName": "sample string 32",
        "ContractEndDate": "2026-08-14T17:38:02.1449814+01:00",
        "MPxN": "sample string 34",
        "Category": "sample string 35",
        "Priority": "sample string 36",
        "Resposible": "sample string 37",
        "Status": "sample string 38",
        "Allocated": "sample string 39",
        "Stage": "sample string 40",
        "Id": 41,
        "TaskType": "sample string 42",
        "ActionCount": 43,
        "ClientName": "sample string 44"
      }
    ]
  },
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ApiResponseOfGridPageResultOfTaskListItemDtoVcCOJ51bVcCOJ51b xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Data>
    <PageCount>4</PageCount>
    <PageIndex>2</PageIndex>
    <PageSize>3</PageSize>
    <Records>
      <TaskListItemDto>
        <ActionCount>43</ActionCount>
        <Allocated>sample string 39</Allocated>
        <AllocatedUserID>3</AllocatedUserID>
        <AllowManualCompletion>15</AllowManualCompletion>
        <BrokerCode>sample string 31</BrokerCode>
        <BusinessPartnerCode>sample string 30</BusinessPartnerCode>
        <Category>sample string 35</Category>
        <ClientID>7</ClientID>
        <ClientName>sample string 44</ClientName>
        <CompletedDate>2026-08-14T17:38:02.1449814+01:00</CompletedDate>
        <ContractEndDate>2026-08-14T17:38:02.1449814+01:00</ContractEndDate>
        <CreatedDate>2026-08-14T17:38:02.1449814+01:00</CreatedDate>
        <DefaultTask>14</DefaultTask>
        <Detail>sample string 24</Detail>
        <DueDate>2026-08-14T17:38:02.1449814+01:00</DueDate>
        <ElecMeterID>16</ElecMeterID>
        <EmployeeID>20</EmployeeID>
        <GasMeterID>17</GasMeterID>
        <Id>41</Id>
        <JobID>8</JobID>
        <MPxN>sample string 34</MPxN>
        <PrdName>sample string 32</PrdName>
        <Priority>sample string 36</Priority>
        <ProductID>11</ProductID>
        <ProspectID>19</ProspectID>
        <QueryID>18</QueryID>
        <Reference>sample string 26</Reference>
        <ResponsibleID>10</ResponsibleID>
        <Resposible>sample string 37</Resposible>
        <Stage>sample string 40</Stage>
        <StageID>12</StageID>
        <StageTaskID>13</StageTaskID>
        <Status>sample string 38</Status>
        <Subject>sample string 22</Subject>
        <SupplierID>9</SupplierID>
        <TaskCategoryID>5</TaskCategoryID>
        <TaskID>1</TaskID>
        <TaskPriorityID>6</TaskPriorityID>
        <TaskStatus>21</TaskStatus>
        <TaskStatusID>2</TaskStatusID>
        <TaskType>sample string 42</TaskType>
        <TaskTypeID>4</TaskTypeID>
        <UpdatedBy>sample string 29</UpdatedBy>
        <UpdatedDate>2026-08-14T17:38:02.1449814+01:00</UpdatedDate>
      </TaskListItemDto>
      <TaskListItemDto>
        <ActionCount>43</ActionCount>
        <Allocated>sample string 39</Allocated>
        <AllocatedUserID>3</AllocatedUserID>
        <AllowManualCompletion>15</AllowManualCompletion>
        <BrokerCode>sample string 31</BrokerCode>
        <BusinessPartnerCode>sample string 30</BusinessPartnerCode>
        <Category>sample string 35</Category>
        <ClientID>7</ClientID>
        <ClientName>sample string 44</ClientName>
        <CompletedDate>2026-08-14T17:38:02.1449814+01:00</CompletedDate>
        <ContractEndDate>2026-08-14T17:38:02.1449814+01:00</ContractEndDate>
        <CreatedDate>2026-08-14T17:38:02.1449814+01:00</CreatedDate>
        <DefaultTask>14</DefaultTask>
        <Detail>sample string 24</Detail>
        <DueDate>2026-08-14T17:38:02.1449814+01:00</DueDate>
        <ElecMeterID>16</ElecMeterID>
        <EmployeeID>20</EmployeeID>
        <GasMeterID>17</GasMeterID>
        <Id>41</Id>
        <JobID>8</JobID>
        <MPxN>sample string 34</MPxN>
        <PrdName>sample string 32</PrdName>
        <Priority>sample string 36</Priority>
        <ProductID>11</ProductID>
        <ProspectID>19</ProspectID>
        <QueryID>18</QueryID>
        <Reference>sample string 26</Reference>
        <ResponsibleID>10</ResponsibleID>
        <Resposible>sample string 37</Resposible>
        <Stage>sample string 40</Stage>
        <StageID>12</StageID>
        <StageTaskID>13</StageTaskID>
        <Status>sample string 38</Status>
        <Subject>sample string 22</Subject>
        <SupplierID>9</SupplierID>
        <TaskCategoryID>5</TaskCategoryID>
        <TaskID>1</TaskID>
        <TaskPriorityID>6</TaskPriorityID>
        <TaskStatus>21</TaskStatus>
        <TaskStatusID>2</TaskStatusID>
        <TaskType>sample string 42</TaskType>
        <TaskTypeID>4</TaskTypeID>
        <UpdatedBy>sample string 29</UpdatedBy>
        <UpdatedDate>2026-08-14T17:38:02.1449814+01:00</UpdatedDate>
      </TaskListItemDto>
    </Records>
    <TotalRecords>1</TotalRecords>
  </Data>
</ApiResponseOfGridPageResultOfTaskListItemDtoVcCOJ51bVcCOJ51b>