POST Agents/Appointment/GetTaskListItems

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Appointment/GetTaskListItems

Gets all takslist items

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Appointment/GetTaskListItems?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

IncludeDeleted

Property Name Type Description
IncludeDeleted Boolean

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
TaskListItemId int32 Primary key
Value string The list item
Direction string 1 = incoming, 2 = outgoing, see EAppntDirection
Type string 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes
Tooltip string Tooltip or other description
Deleted bool If true, the Task list item is deleted
IntentId int32 Link to the intention of this kind of task (used by SAINT)
Rank int32 Rank order
IsDefaultAlldayEvent bool True if all day event
IsDefaultFree bool True if free, false if busy
IsDefaultPublished bool Published to external persons
ColorIndex string JAP
DefaultVideomeetingStatus string Default video-meeting status for meetings created in SuperOffice CRM.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Appointment/GetTaskListItems
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "IncludeDeleted": true
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "TaskListItemId": 336,
    "Value": "est",
    "Direction": "Incoming",
    "Type": "Appointment",
    "Tooltip": "perspiciatis",
    "Deleted": true,
    "IntentId": 269,
    "Rank": 717,
    "IsDefaultAlldayEvent": false,
    "IsDefaultFree": false,
    "IsDefaultPublished": false,
    "ColorIndex": "BlueAlt1",
    "DefaultVideomeetingStatus": "NoChange",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 622
      }
    }
  }
]