GET api/resource?startDate={startDate}&endDate={endDate}&project={project}&user={user}
Retrieves resource booking information filtered by date, project, or user.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| startDate |
(Optional) The start date to filter resource bookings. Only bookings starting on or after this date are included. |
date |
None. |
| endDate |
(Optional) The end date to filter resource bookings. Only bookings ending on or before this date are included. |
date |
None. |
| project |
(Optional) The ID of the project to filter bookings. Defaults to 0 (no filter). |
integer |
Default value is 0 |
| user |
(Optional) The ID of the user to filter bookings. Defaults to 0 (no filter). |
integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
On success: HTTP 200 OK with a list of resource summaries. On failure: HTTP 400 Bad Request with a generic error message.
Collection of ResourceSummary| Name | Description | Type | Additional 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
[
{
"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": "2025-11-21T03:20:00.5565061+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
"start": "2025-11-21T03:20:00.5565061+00:00",
"end": "2025-11-21T03:20:00.5565061+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": "2025-11-21T03:20:00.5565061+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
"start": "2025-11-21T03:20:00.5565061+00:00",
"end": "2025-11-21T03:20:00.5565061+00:00",
"hrs": 6,
"bookingID": 7,
"taskID": 8
}
]
application/scim+json
[
{
"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",
"label": null,
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"label": null,
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2025-11-21T03:20:00.5565061+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
"start": "2025-11-21T03:20:00.5565061+00:00",
"end": "2025-11-21T03:20:00.5565061+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",
"label": null,
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"label": null,
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2025-11-21T03:20:00.5565061+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
"start": "2025-11-21T03:20:00.5565061+00:00",
"end": "2025-11-21T03:20:00.5565061+00:00",
"hrs": 6,
"bookingID": 7,
"taskID": 8
}
]