Client Reports

Provides access to Task Force client reports for third-party applications.

Methods:

• CreateClientReport - Creates a Task Force client report with the specified parameters.
• DeleteClientReport - Deletes a Task Force client report with the specified ID.
• GetClientReport - Retrieves all of the explicit details of a client report with the specified ID. ReportType values: 1 - Breakdown, 2 - Grid, 3 - TimeLog.
• ListClientReports - Returns a listing of Task Force client reports.
• UpdateClientReport - Updates a Task Force client report 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.

CreateClientReport

Creates a Task Force client report 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.
• reportType - The type of the client report.
• delineations - The delineations of the client report. Each number is a custom field ID, except when less than zero, in which case -1 means "by task" and -2 means "by user".
• taskNameFilter - The task name filter setting for the report.
• customFieldFilters - The custom field filter settings for the report.
• dateFrom - The "From Date" filter setting for the report.
• dateTo - The "To Date" filter setting for the report.
• userIds - The users filter setting for the report.
• clientUserIds - The IDs of the client users than have access to the client report.
• name - The name of the client report.
• description - The description of the client report.
• displayNotes - True if the report should display task and/or time segment notes (if it can do so); otherwise, false.

Example Request:

POST /API/ClientReports.aspx/CreateClientReport HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 505

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "reportType": "Unspecified -or- Breakdown -or- Grid -or- TimeLog",
  "delineations": [
    0
  ],
  "taskNameFilter": "string",
  "customFieldFilters": [
    {
      "customFieldId": 0,
      "filter": "string"
    }
  ],
  "dateFrom": "string",
  "dateTo": "string",
  "userIds": [
    0
  ],
  "clientUserIds": [
    0
  ],
  "name": "string",
  "description": "string",
  "displayNotes": false
}

Example Response:

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

{
  "Response": "00000000-0000-0000-0000-000000000000",
  "Error": "string"
}

DeleteClientReport

Deletes a Task Force client report 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 report to be deleted.

Example Request:

POST /API/ClientReports.aspx/DeleteClientReport HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 132

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": "00000000-0000-0000-0000-000000000000"
}

Example Response:

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

{
  "Error": "string"
}

GetClientReport

Retrieves all of the explicit details of a client report with the specified ID. ReportType values: 1 - Breakdown, 2 - Grid, 3 - TimeLog.

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 report to be retrieved.

Example Request:

POST /API/ClientReports.aspx/GetClientReport HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 132

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": "00000000-0000-0000-0000-000000000000"
}

Example Response:

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

{
  "Response": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "ReportType": 0,
    "Delineations": [
      0
    ],
    "TaskNameFilter": "string",
    "CustomFieldFilters": [
      {
        "customFieldId": 0,
        "filter": "string"
      }
    ],
    "DateFrom": "string",
    "DateTo": "string",
    "UserIds": [
      0
    ],
    "ClientUserIds": [
      0
    ],
    "Name": "string",
    "Description": "string",
    "DisplayNotes": false
  },
  "Error": "string"
}

ListClientReports

Returns a listing of Task Force client reports.

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.

Example Request:

POST /API/ClientReports.aspx/ListClientReports HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 83

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

Example Response:

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

{
  "Response": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "string",
      "Description": "string",
      "ClientReportType": 0,
      "For": "string"
    }
  ],
  "Error": "string"
}

UpdateClientReport

Updates a Task Force client report 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 client report to be updated.
• delineations - The delineations of the client report. Each number is a custom field ID, except when less than zero, in which case -1 means "by task" and -2 means "by user".
• taskNameFilter - The task name filter setting for the report.
• customFieldFilters - The custom field filter settings for the report.
• dateFrom - The "From Date" filter setting for the report.
• dateTo - The "To Date" filter setting for the report.
• userIds - The users filter setting for the report.
• clientUserIds - The IDs of the client users than have access to the client report.
• name - The name of the client report.
• description - The description of the client report.
• displayNotes - True if the report should display task and/or time segment notes (if it can do so); otherwise, false.

Example Request:

POST /API/ClientReports.aspx/UpdateClientReport HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 484

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "delineations": [
    0
  ],
  "taskNameFilter": "string",
  "customFieldFilters": [
    {
      "customFieldId": 0,
      "filter": "string"
    }
  ],
  "dateFrom": "string",
  "dateTo": "string",
  "userIds": [
    0
  ],
  "clientUserIds": [
    0
  ],
  "name": "string",
  "description": "string",
  "displayNotes": false
}

Example Response:

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

{
  "Error": "string"
}