Get Assigned Space
- Elliot Dooleysmith
Overview
Request for a users Assigned space.
This will return the user's assigned space and current & future availability bookings for this space.
Details
Type
GET
Endpoint
{{url}}/api/Users/GetAssignedSpace
Request
The request will have two valid parameters.
The UserId or EmailAddress can be used; at least one is required.
Both values can be used to return the selected users' Assigned space detail correctly.
Example
{
"UserId": int,
"EmailAddress": "string (email address)"
}Response
The response will include the user’s information as specified in the request.
UserIdEmailAddress
Also an array of the user’s assigned spaces.
The Assigned resource’s ID (ResId) and display name (ResName) will be returned.
ResId- The ID value for the Assigned space.ResName- The display name for the Assigned space.SpaceType- The space type for the Assigned space. (Not required for initial release)IconPath- The URL path to the icon for the Assigned space. (Not required for initial release)MapId- An array of Map IDs that the Assigned space is added to. (Not required for initial release)
An array of dates that the Assigned space is not being used by the owner.
AvailableForColleagueDates- An array of objects which include start and end dates.Id- A unique ID value for each availability booking.StartDate- The start date for an availability booking.EndDate- The end date for an availability booking.
Example
{
"UserId": int,
"EmailAddress": "string (email address)",
"AssignedSpaces": Array[
Object{
"ResId": int,
"ResName": "string",
"SpaceType": "string",
"IconPath": "string"
"MapId": Array[int,int],
"AvailableForColleagueDates": Array[
Object{
"Id": int,
"StartDate": "dd/MM/yyyy",
"EndDate": "dd/MM/yyyy",
}
]
},
Object{
"ResId": int,
"ResName": "string",
"SpaceType": "string",
"IconPath": "string"
"MapId": Array[int,int],
"AvailableForColleagueDates": Array[
Object{
"Id": int,
"StartDate": "dd/MM/yyyy",
"EndDate": "dd/MM/yyyy",
}
]
}
]
}