Search
Search desks
API
- Introduction
- Authentication
- Department
- Department Image
- Desk
- Equipment
- Password
- Report
- Reservation
- Room
- Search
- Self
- Session
- Stats
- User
- User Avatar
Search
Search desks
Search for desks based on the provided criteria.
POST
/
api
/
search
/
desks
curl --request POST \
--url http://localhost/api/search/desks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"department": {
"location": "<string>",
"building": "<string>",
"floor": 123
},
"room": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"available": true
},
"desk": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "FIXED"
},
"equipment": [
{
"type": "DOCKING_STATION",
"name": "<string>"
}
],
"reservation": {
"full": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"free": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"partlyBetween": {
"seconds": 123,
"zero": true,
"nano": 123,
"negative": true,
"positive": true,
"units": [
{
"durationEstimated": true,
"timeBased": true,
"dateBased": true
}
]
},
"partlyReserved": true
}
}
}'
{
"totalElements": 123,
"totalPages": 123,
"size": 123,
"content": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "FIXED",
"roomId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"departmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"number": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"first": true,
"last": true,
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"pageSize": 123,
"pageNumber": 123,
"paged": true,
"unpaged": true
},
"empty": true
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Body
application/json
Response
200
*/*
Desks successfully retrieved
Was this page helpful?
curl --request POST \
--url http://localhost/api/search/desks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"department": {
"location": "<string>",
"building": "<string>",
"floor": 123
},
"room": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"available": true
},
"desk": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "FIXED"
},
"equipment": [
{
"type": "DOCKING_STATION",
"name": "<string>"
}
],
"reservation": {
"full": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"free": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"partlyBetween": {
"seconds": 123,
"zero": true,
"nano": 123,
"negative": true,
"positive": true,
"units": [
{
"durationEstimated": true,
"timeBased": true,
"dateBased": true
}
]
},
"partlyReserved": true
}
}
}'
{
"totalElements": 123,
"totalPages": 123,
"size": 123,
"content": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "FIXED",
"roomId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"departmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"number": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"first": true,
"last": true,
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": [
{
"direction": "<string>",
"nullHandling": "<string>",
"ascending": true,
"property": "<string>",
"ignoreCase": true
}
],
"pageSize": 123,
"pageNumber": 123,
"paged": true,
"unpaged": true
},
"empty": true
}