GET api/resource?startDate={startDate}&endDate={endDate}&project={project}&user={user}

Returns a full list of resource information that have been assigned to a user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

Only return when resourced on or after this date

date

None.

endDate

Only return when resourced before or on this date

date

None.

project

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

integer

Default value is 0

user

Unique userid to limit results to just resource items for this user

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Resource info

Collection of ResourceSummary
NameDescriptionTypeAdditional information
project

Project ID

integer

None.

title

Project Title

string

None.

item

The item that the resource relates, if empty it is a general project booking

string

None.

user

User Details

ViewUserDTO

None.

start

Start Date

date

None.

end

End Date

date

None.

hrs

Total hours for this booking

integer

None.

bookingID

Booking ID

integer

None.

taskID

Task ID

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "project": 1,
    "title": "sample string 2",
    "item": "sample string 3",
    "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-09-08T03:15:40.5926066+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "start": "2024-09-08T03:15:40.5926066+00:00",
    "end": "2024-09-08T03:15:40.5926066+00:00",
    "hrs": 6,
    "bookingID": 7,
    "taskID": 8
  },
  {
    "project": 1,
    "title": "sample string 2",
    "item": "sample string 3",
    "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-09-08T03:15:40.5926066+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "start": "2024-09-08T03:15:40.5926066+00:00",
    "end": "2024-09-08T03:15:40.5926066+00:00",
    "hrs": 6,
    "bookingID": 7,
    "taskID": 8
  }
]