GET api/timesheet/summary?week={week}&user={user}&project={project}

Returns a timesheet summary, all users and the projects they are timesheeted against including the total hours for that project per week

Request Information

URI Parameters

NameDescriptionTypeAdditional information
week

The date for the week ending (Sunday) to limit results to this one week, use format year-month-day

string

None.

user

User id to limit results to, leave blank to return all users

integer

Default value is 0

project

Project id to limit results to, leave blank to return all projects

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Timesheet info

Collection of TimesheetSummary
NameDescriptionTypeAdditional information
user

User Details

ViewUserDTO

None.

summary

The week ending

Collection of TimesheetSummaryRow

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "user": {
      "userID": 1,
      "userName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "customFields": [
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        },
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        }
      ],
      "status": "sample string 6",
      "createDate": "2024-10-18T07:51:23.9796653+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "summary": [
      {
        "weekEnding": "2024-10-18T07:51:23.9796653+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      },
      {
        "weekEnding": "2024-10-18T07:51:23.9796653+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      }
    ]
  },
  {
    "user": {
      "userID": 1,
      "userName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "customFields": [
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        },
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        }
      ],
      "status": "sample string 6",
      "createDate": "2024-10-18T07:51:23.9796653+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "summary": [
      {
        "weekEnding": "2024-10-18T07:51:23.9796653+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      },
      {
        "weekEnding": "2024-10-18T07:51:23.9796653+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      }
    ]
  }
]