Time Segments

Provides access to Task Force time segment management functions for third-party applications.

Methods:

• CreateTimeSegment - Creates a Task Force time segment with the specified parameters.
• DeleteTimeSegment - Deletes a Task Force time segment with the specified ID.
• ListTimeSegments - Returns a list of Task Force time segments.
• ListUninvoicedTimeSegments - Returns a list of uninvoiced Task Force time segments.
• UpdateTimeSegment - Updates a Task Force time segment with the specified parameters.

General Notes: All Scaffold web methods require that the Content Type of your request is "application/scaffold+json". The Host and Content-Length headers are not required. Scaffold's response Content-Type will always be "application/json". The formatting of JSON shown in the examples on this page is not enforced in requests or necessarily followed in responses--it is only shown as such to enhance human readability--assume that you can send (and may receive) any legal JSON that has the same object, property, and array structures.

CreateTimeSegment

Creates a Task Force time segment with the specified parameters.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• userId - The ID of the user for which the time segment is entered.
• taskId - The ID of the task for which the time segment is entered.
• start - The starting point of the time segment in Coordinated Universal Time (e.g. "2010-07-31T12:45:29Z").
• end - The starting point of the time segment in Coordinated Universal Time (e.g. "2010-07-31T12:45:29Z").
• notes - The notes for the time segment.

Example Request:

POST /API/TimeSegments.aspx/CreateTimeSegment HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 179

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "userId": 0,
  "taskId": 0,
  "start": "string",
  "end": "string",
  "notes": "string"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 43

{
  "Response": 0,
  "Error": "string"
}

DeleteTimeSegment

Deletes a Task Force time segment with the specified ID.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• id - The ID of the time segment to be deleted.

Example Request:

POST /API/TimeSegments.aspx/DeleteTimeSegment HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 95

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": 0
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 25

{
  "Error": "string"
}

ListTimeSegments

Returns a list of Task Force time segments.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• limit - The maximum number of time segments to return; otherwise, specify null to impose no such limit.
• taskNameFilter - The text that must appear in a time segment's task's name for it to be included in the results; otherwise, specify null to impose no such requirement of inclusion.
• customFieldFilters - The custom field filters that a time segment's task must meet to be included in the results; otherwise, specify null or a zero-length array to impose no such requirements.
• dateFrom - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateTo are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
• dateTo - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateFrom are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
• userIds - An array specifying the users who must have logged time in order for it to be included. If null or empty, users will not be considered.

Example Request:

POST /API/TimeSegments.aspx/ListTimeSegments HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 306

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "limit": 0,
  "taskNameFilter": "string",
  "customFieldFilters": [
    {
      "customFieldId": 0,
      "filter": "string"
    }
  ],
  "dateFrom": "string",
  "dateTo": "string",
  "userIds": [
    0
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 434

{
  "Response": [
    {
      "Id": 0,
      "Start": "string",
      "End": "string",
      "Duration": 0,
      "Notes": "string",
      "TaskId": 0,
      "TaskName": "string",
      "TaskCustomValues": [
        {
          "CustomFieldId": 0,
          "CustomFieldName": "string",
          "Value": "string"
        }
      ],
      "UserId": 0,
      "UserName": "string"
    }
  ],
  "Error": "string"
}

ListUninvoicedTimeSegments

Returns a list of uninvoiced Task Force time segments.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• limit - The maximum number of time segments to return; otherwise, specify null to impose no such limit.
• taskNameFilter - The text that must appear in a time segment's task's name for it to be included in the results; otherwise, specify null to impose no such requirement of inclusion.
• customFieldFilters - The custom field filters that a time segment's task must meet to be included in the results; otherwise, specify null or a zero-length array to impose no such requirements.
• dateFrom - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateTo are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
• dateTo - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateFrom are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
• userIds - An array specifying the users who must have logged time in order for it to be included. If null or empty, users will not be considered.

Example Request:

POST /API/TimeSegments.aspx/ListUninvoicedTimeSegments HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 306

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "limit": 0,
  "taskNameFilter": "string",
  "customFieldFilters": [
    {
      "customFieldId": 0,
      "filter": "string"
    }
  ],
  "dateFrom": "string",
  "dateTo": "string",
  "userIds": [
    0
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 434

{
  "Response": [
    {
      "Id": 0,
      "Start": "string",
      "End": "string",
      "Duration": 0,
      "Notes": "string",
      "TaskId": 0,
      "TaskName": "string",
      "TaskCustomValues": [
        {
          "CustomFieldId": 0,
          "CustomFieldName": "string",
          "Value": "string"
        }
      ],
      "UserId": 0,
      "UserName": "string"
    }
  ],
  "Error": "string"
}

UpdateTimeSegment

Updates a Task Force time segment with the specified parameters.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• id - The ID of the time segment to be updated.
• taskId - The ID of the task for which the time segment is entered.
• start - The starting point of the time segment in Coordinated Universal Time (e.g. "2010-07-31T12:45:29Z").
• end - The starting point of the time segment in Coordinated Universal Time (e.g. "2010-07-31T12:45:29Z").
• notes - The notes for the time segment.

Example Request:

POST /API/TimeSegments.aspx/UpdateTimeSegment HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 175

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": 0,
  "taskId": 0,
  "start": "string",
  "end": "string",
  "notes": "string"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 25

{
  "Error": "string"
}