GET api/Tasks/Calendar

Retrieves a list of calendar items for a member over a given period.

Request

Parameters

Name Description Default
member Unique member ID. Omit to view the current user's calendar.
from Start of the period.
to End of the period (inclusive).
includeTasks Whether to include due tasks on the calendar. false

Response

Body

Content Type: application/xml or application/json
Data set containing the calendar items, or an error message.

XML JSON
<Response>                                        
  <Result>                                        
    <Tasks>                                       <!--Array of 'Item'--> 
      <Item>                                      
        <Title>string</Title>                     
        <Description>string</Description>         <!--Description of the current step--> 
        <FileID>long</FileID>                     <!--Unique file ID--> 
        <Style>int</Style>                        <!--Task style (0=normal, 1=appointment)--> 
        <StartDate>datetime</StartDate>           
        <Duration>decimal</Duration>              <!--Appointment duration (in hours)--> 
        <DueDate>datetime</DueDate>               
        <Priority>int</Priority>                  <!--Priority level (0-4)--> 
        <LastAction>string</LastAction>           <!--Date and member code of last action--> 
        <DBRecordID>long</DBRecordID>             <!--Unique ID of related record--> 
        <ItemID>long</ItemID>                     <!--Unique task ID.--> 
        <ActivityID>long</ActivityID>             <!--Unique activity ID.--> 
        <HasRemarks>bool</HasRemarks>             <!--Whether the task has remarks--> 
        <HasCommenced>bool</HasCommenced>         <!--Whether the task has commenced--> 
        <SequenceNo>int</SequenceNo>              <!--1-based index of the current step--> 
        <MemberFlags>int</MemberFlags>            <!--Attributes for the current user--> 
        <IsRecurring>bool</IsRecurring>           <!--Whether the task is recurring--> 
        <RecurrenceSize>int</RecurrenceSize>      <!--Unit of recurrence--> 
        <RecurrenceValue>int</RecurrenceValue>    <!--Frequency of recurrence--> 
        <IsAttendee>bool</IsAttendee>             <!--Whether the current user is an attendee--> 
        <IsOptional>bool</IsOptional>             <!--Whether attendance for the current user is optional--> 
        <FileNumber>string</FileNumber>           <!--Human-readable file number--> 
        <Venue>string</Venue>                     <!--Conference venue--> 
        <EventColor>string</EventColor>           <!--Name/code of custom event colour--> 
        <Delegation>string</Delegation>           <!--Member code or group to whom the task is delegated--> 
        <IsDue>bool</IsDue>                       <!--Whether the task is overdue--> 
      </Item>                                     
    </Tasks>                                      
    <Items>                                       <!--Array of 'Item'--> 
      <Item>                                      
        <Type>int</Type>                          <!--Calendar item type--> 
        <DBRecordID>long</DBRecordID>             <!--Unique ID of related record--> 
        <Date>datetime</Date>                     <!--Calendar item date--> 
        <Duration>decimal</Duration>              <!--Duration (in hours)--> 
        <Description>string</Description>         <!--Calendar item description--> 
      </Item>                                     
    </Items>                                      
  </Result>                                       
  <Message>string</Message>                       <!--Error message--> 
</Response>                                       
{                                     
   "Result": {                        
      "Tasks": [{                     
         "Title": "string",           
         "Description": "string",     // Description of the current step
         "FileID": "long",            // Unique file ID
         "Style": "int",              // Task style (0=normal, 1=appointment)
         "StartDate": "datetime",     
         "Duration": "decimal",       // Appointment duration (in hours)
         "DueDate": "datetime",       
         "Priority": "int",           // Priority level (0-4)
         "LastAction": "string",      // Date and member code of last action
         "DBRecordID": "long",        // Unique ID of related record
         "ItemID": "long",            // Unique task ID.
         "ActivityID": "long",        // Unique activity ID.
         "HasRemarks": "bool",        // Whether the task has remarks
         "HasCommenced": "bool",      // Whether the task has commenced
         "SequenceNo": "int",         // 1-based index of the current step
         "MemberFlags": "int",        // Attributes for the current user
         "IsRecurring": "bool",       // Whether the task is recurring
         "RecurrenceSize": "int",     // Unit of recurrence
         "RecurrenceValue": "int",    // Frequency of recurrence
         "IsAttendee": "bool",        // Whether the current user is an attendee
         "IsOptional": "bool",        // Whether attendance for the current user is optional
         "FileNumber": "string",      // Human-readable file number
         "Venue": "string",           // Conference venue
         "EventColor": "string",      // Name/code of custom event colour
         "Delegation": "string",      // Member code or group to whom the task is delegated
         "IsDue": "bool"              // Whether the task is overdue
      }],                             
      "Items": [{                     
         "Type": "int",               // Calendar item type
         "DBRecordID": "long",        // Unique ID of related record
         "Date": "datetime",          // Calendar item date
         "Duration": "decimal",       // Duration (in hours)
         "Description": "string"      // Calendar item description
      }]                              
   },                                 
   "Message": "string"                // Error message
}                                     
                                      

Status Codes

Code Condition
200 OK The operation completed successfully.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenUser does not have permission to view the calendar.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

The calendar item type can be one of the following values:
ValueDescription
1Holiday / office closed
2Leave
3Out of office