Assets
Services Controller - BETA - Subject to change
| API | Description |
|---|---|
| GET api/Assets/GetAssetsInPool?poolId={poolId} |
Get Service Order Phase lookup data |
| POST api/Assets/ItemAssetReservations |
Return the Items that have associated assets (if any) and if they are busy/available during the time window specified |
Configuration
Configuration Controller
| API | Description |
|---|---|
| GET api/Configuration/GetCustomTabList?languageId={languageId} |
Get Custom Tab List |
| GET api/Configuration/GetCustomTab?requestTabId={requestTabId}&languageId={languageId} |
Get Custom Tab |
| POST api/Configuration/AddCustomTab |
Add Custom Tab Udfs are added separately Only accessible by Administrative Users |
| PUT api/Configuration/UpdateCustomTab |
Update Custom Tab Udfs are added and deleted separately Only accessible by Administrative Users |
| DELETE api/Configuration/DeleteCustomTab?requestTabId={requestTabId} |
Delete Custom Tab Logical deletion of custom tab and removal of any Group associations Only accessible by Administrative Users |
| PUT api/Configuration/AddUdfsToCustomTab |
Add Udfs to Custom Tab Only accessible by Administrative Users Invalid Udf Ids are ignored |
| DELETE api/Configuration/DeleteUdfsFromCustomTab |
Delete Udfs from Custom Tab Only accessible by Administrative Users Invalid Udf Ids are ignored |
| API | Description |
|---|---|
| GET api/Email/SendNotificationEmail?reservationId={reservationId} |
Send Resource Scheduler Notification email |
| POST api/Email/SendNotificationEmailRSO365?reservationId={reservationId} |
Send Resource Scheduler Notification email for RSO365 Sends to Approvers, if pending, and Resource Notification Email Address, if set, but not Attendees since Outlook will notify them Helper method |
| POST api/Email/SendServiceNotificationEmail?orderId={orderId}&stringId={stringId}&series={series} |
Send a Service email |
EventLog
Event Log Retrieves latest log4net log entries Only accessible by Administrative Users
| API | Description |
|---|---|
| GET api/EventLog |
Get Event Log files Retrieves latest log4net log entries Only accessible by Administrative Users |
Group
Deprecated Endpoint - Use GroupV2
| API | Description |
|---|---|
| GET api/Location/GetGroupList?locationId={locationId}&summaryOnly={summaryOnly} |
Get Group List |
| GET api/Group?locationId={locationId}&summaryOnly={summaryOnly} |
Get Group List |
| GET api/Location/GetGroup?groupId={groupId} |
Get Group |
| GET api/Group?groupId={groupId} |
Get Group |
GroupV2
Group Controller
| API | Description |
|---|---|
| GET api/v2/Group/GetGroupSummaryList?locationId={locationId} |
Get Group Summary List |
| GET api/v2/Group/GetGroupList?locationId={locationId} |
Get Group List Only returns the groups to which the logged in user has access |
| GET api/v2/Group/GetGroup?groupId={groupId} |
Get Group |
| POST api/v2/Group/AddGroup |
Add Group Custom Tabs and Udfs are added separately Only accessible by Administrative Users |
| PUT api/v2/Group/UpdateGroup |
Update Group Custom Tabs and Udfs are updated separately Only accessible by Administrative Users |
| DELETE api/v2/Group/DeleteGroup?groupId={groupId} |
Delete Group Only accessible by Administrative Users |
| PUT api/v2/Group/AddCustomTabsToGroup |
Add Custom Tabs to Group Only accessible by Administrative Users Invalid Request Tab Ids are ignored |
| DELETE api/v2/Group/DeleteCustomTabsFromGroup |
Delete Custom Tabs from Group Only accessible by Administrative Users Invalid Request Tab Ids are ignored |
| PUT api/v2/Group/AddUdfsToGroup |
Add Udfs to Group Udf Type 0 = Resource Characteristic, 1 = Reservation Prompt Only accessible by Administrative Users Invalid Udf Ids are ignored |
| DELETE api/v2/Group/DeleteUdfsFromGroup |
Delete Udfs from Group Only accessible by Administrative Users Invalid Udf Ids are ignored |
Identity
Identity
| API | Description |
|---|---|
| GET api/Identity |
Returns identity claims/information for the current logged in user This endpoint should only be called once after the initial login, if necessary |
Kiosk
| API | Description |
|---|---|
| GET api/Kiosk/GetKioskImage?imageId={imageId} |
Get Kiosk Image object |
| GET api/Kiosk/GetKioskImageRaw?imageId={imageId} |
Get Kiosk Image in raw format |
| GET api/Kiosk/GetKioskHotspotList?nodeId={nodeId} |
Get Kiosk Hotspot List |
| GET api/Kiosk/GetResizedKioskImageAndHotspotList?nodeId={nodeId}&imageId={imageId}&maxSize={maxSize}&omitHotelingResources={omitHotelingResources} |
Get Resized Kiosk Image and Kiosk Hotspot List |
| GET api/Kiosk/GetKioskHotspotListByNodeIdList?nodeIdList[0]={nodeIdList[0]}&nodeIdList[1]={nodeIdList[1]} |
Get Kiosk Hotspot List |
| GET api/Kiosk/GetKioskNode?nodeId={nodeId} |
Get Kiosk Node |
| GET api/Kiosk/GetKioskNodeListByTitle?title={title} |
Get Kiosk Node List by title |
| GET api/Kiosk/GetKioskNodeListByParentNodeId?parentNodeId={parentNodeId} |
Get Kiosk Node List by parent node id |
| GET api/Kiosk/GetKioskNodeListByLocationId?locationId={locationId}&groupId={groupId} |
Get Kiosk Node List by location id Note: Only Group or Location can be specified |
| GET api/Kiosk/GetResourceKioskNodeList?resourceId={resourceId} |
Retrieves Kiosk and Resource info for any kiosk nodes which contain an active hotspot for the specified resource |
| POST api/Kiosk/AddKioskImage |
Add Kiosk Image JPG image as a base64 string Only accessible by Administrative Users |
| PUT api/Kiosk/UpdateKioskImage |
Update Kiosk Image JPG image as a base64 string Only accessible by Administrative Users |
| DELETE api/Kiosk/DeleteKioskImage?imageId={imageId} |
Delete Kiosk Image Only accessible by Administrative Users |
| POST api/Kiosk/AddKioskNode |
Add Kiosk Node Only accessible by Administrative Users |
| PUT api/Kiosk/UpdateKioskNode |
Update Kiosk Node Only accessible by Administrative Users |
| DELETE api/Kiosk/DeleteKioskNode?nodeId={nodeId} |
Delete Kiosk Node Logical deletion of the current node and all child nodes, including hotspots and hotspot points Only accessible by Administrative Users |
| POST api/Kiosk/AddKioskHotspot |
Add Kiosk Hotspot and Kiosk Hotspot Point coordinates Only accessible by Administrative Users |
| PUT api/Kiosk/UpdateKioskHotspot |
Update Kiosk Hotspot and Kiosk Hotspot Point coordinates Existing point coordinates are deleted and re-added Only accessible by Administrative Users |
| DELETE api/Kiosk/DeleteKioskHotspot?hotspotId={hotspotId} |
Delete Kiosk Hotspot Logical deletion of hotspot and all associated kiosk points and cad metadata Only accessible by Administrative Users |
KioskV2
| API | Description |
|---|---|
| GET api/v2/Kiosk/GetKioskImage?imageId={imageId} |
Get Kiosk Image object |
| GET api/v2/Kiosk/GetKioskImageRaw?imageId={imageId} |
Get Kiosk Image in raw format |
| GET api/v2/Kiosk/GetKioskHotspotList?nodeId={nodeId} |
Get Kiosk Hotspot List |
| GET api/v2/Kiosk/GetResizedKioskImageAndHotspotList?nodeId={nodeId}&imageId={imageId}&maxSize={maxSize}&omitHotelingResources={omitHotelingResources} |
Get Resized Kiosk Image and Kiosk Hotspot List |
| GET api/v2/Kiosk/GetKioskHotspotListByNodeIdList?nodeIdList[0]={nodeIdList[0]}&nodeIdList[1]={nodeIdList[1]} |
Get Kiosk Hotspot List |
| GET api/v2/Kiosk/GetKioskNode?nodeId={nodeId} |
Get Kiosk Node |
| GET api/v2/Kiosk/GetKioskNodeListByTitle?title={title} |
Get Kiosk Node List by title |
| GET api/v2/Kiosk/GetKioskNodeListByParentNodeId?parentNodeId={parentNodeId} |
Get Kiosk Node List by parent node id |
| GET api/v2/Kiosk/GetKioskNodeListByLocationId?locationId={locationId}&groupId={groupId} |
Get Kiosk Node List by location id Note: Only Group or Location can be specified |
| GET api/v2/Kiosk/GetResourceKioskNodeList?resourceId={resourceId} |
Retrieves Kiosk and Resource info for any kiosk nodes which contain an active hotspot for the specified resource |
| POST api/v2/Kiosk/AddKioskImage |
Add Kiosk Image JPG image as a base64 string Only accessible by Administrative Users |
| PUT api/v2/Kiosk/UpdateKioskImage |
Update Kiosk Image JPG image as a base64 string Only accessible by Administrative Users |
| DELETE api/v2/Kiosk/DeleteKioskImage?imageId={imageId} |
Delete Kiosk Image Only accessible by Administrative Users |
| POST api/v2/Kiosk/AddKioskNode |
Add Kiosk Node Only accessible by Administrative Users |
| PUT api/v2/Kiosk/UpdateKioskNode |
Update Kiosk Node Only accessible by Administrative Users |
| DELETE api/v2/Kiosk/DeleteKioskNode?nodeId={nodeId} |
Delete Kiosk Node Logical deletion of the current node and all child nodes, including hotspots and hotspot points Only accessible by Administrative Users |
| POST api/v2/Kiosk/AddKioskHotspot |
Add Kiosk Hotspot and Kiosk Hotspot Point coordinates Only accessible by Administrative Users |
| PUT api/v2/Kiosk/UpdateKioskHotspot |
Update Kiosk Hotspot and Kiosk Hotspot Point coordinates Existing point coordinates are deleted and re-added Only accessible by Administrative Users |
| DELETE api/v2/Kiosk/DeleteKioskHotspot?hotspotId={hotspotId} |
Delete Kiosk Hotspot Logical deletion of hotspot and all associated kiosk points and cad metadata Only accessible by Administrative Users |
Location
Deprecated Endpoint - Use LocationV2
| API | Description |
|---|---|
| GET api/Location/GetLocationSummaryList?regionId={regionId} |
Get Location Summary List by Region Id |
| GET api/Location/GetLocationList?regionId={regionId} |
Get Location List by Region Id |
| GET api/Location?regionId={regionId} |
Get Location List by Region Id |
| GET api/Location/GetLocation?locationId={locationId} |
Get Location |
| GET api/Location?locationId={locationId} |
Get Location |
| GET api/Location/GetLocationHolidays?locationId={locationId}&startDate={startDate}&endDate={endDate} |
Return the Holidays for the given between dates and |
LocationV2
Location Controller
| API | Description |
|---|---|
| GET api/v2/Location/GetLocationSummaryList?regionId={regionId} |
Get Location Summary List by Region Id |
| GET api/v2/Location/GetLocationList?regionId={regionId} |
Get Location List by Region Id |
| GET api/v2/Location/GetLocation?locationId={locationId} |
Get Location |
| GET api/v2/Location/GetLocationHolidays?locationId={locationId}&startDate={startDate}&endDate={endDate} |
Return the Holidays for the given between dates and |
| POST api/v2/Location/AddLocation |
Add Location Default Location values are used to initialize Time Fence, Calendar Display, Quick Reserve Templates Use UpdateLocation to update those specific values after the location has been created Only accessible by Administrative Users |
| PUT api/v2/Location/UpdateLocation |
Update Location Only accessible by Administrative Users |
| DELETE api/v2/Location/DeleteLocation?locationId={locationId} |
Delete Location Only accessible by Administrative Users |
| DELETE api/v2/Location/DeleteQuickReserveTemplate?templateId={templateId} |
Delete Quick Reserve Template Only accessible by Administrative Users |
| GET api/v2/Location/GetCountryList |
Get Country List Note: The country code returned in this list is used for Location Add/Update to determine which country's holiday schedule to honor. For a specific holiday list for a location, use: GetLocationHolidays method |
Region
Region Controller
| API | Description |
|---|---|
| GET api/region/GetRegionListByUser |
Return the list of Regions that the current user is allowed to access |
| GET api/Region |
Get Region List |
| GET api/Region?regionId={regionId} |
Get Region |
Reservation
Reservation Controller
Resource
Deprecated Endpoint - Use ResourceV2
ResourceV2
General Resource related endpoints
Security
| API | Description |
|---|---|
| PUT api/Security/RegisterKeycard |
No documentation available. |
| GET api/Security/GetSSOSettingsList |
Retrieve SSO Settings list |
| GET api/Security?userId={userId}&resourceId={resourceId} |
Get Security Permissions |
| POST api/Security?username={username}&password={password} |
No documentation available. |
| GET api/Security |
No documentation available. |
| POST api/Security?nameId={nameId}&ssoSettingsId={ssoSettingsId} |
Saml Logout |
SecurityGroup
| API | Description |
|---|---|
| POST api/SecurityGroup/InsertSecurityAssignment?userId={userId}&securityGroupId={securityGroupId} |
Insert security assignment |
| DELETE api/SecurityGroup/DeleteSecurityAssignment?userId={userId}&securityGroupId={securityGroupId} |
Delete security assignment |
| DELETE api/SecurityGroup/DeleteAllSecurityAssignments?userId={userId} |
Delete all security assignments for the specified user |
| GET api/SecurityGroup/GetSecurityGroups |
Get Security Groups |
| GET api/SecurityGroup/GetUserSecurityGroups?userId={userId} |
Get Security Groups for the specified user |
SensorData
Sensor Data Controller
| API | Description |
|---|---|
| POST api/SensorData |
Add Sensor Data |
Services
Services Controller
Strings
Strings
| API | Description |
|---|---|
| GET api/Strings/GetServicesStringList?languageId={languageId}&stringIds={stringIds} |
Get Services String List An empty stringIds parameter will return all strings for that language |
| GET api/Strings/GetStringList?languageId={languageId}&stringIds={stringIds} |
Get String List An empty stringIds parameter will return all strings for that language |
| GET api/Strings/GetStrings?languageId={languageId}&stringIds={stringIds} |
Get String List An empty stringIds parameter will return all strings for that language |
| GET api/Strings?languageId={languageId}&stringIds={stringIds} |
Get String List An empty stringIds parameter will return all strings for that language |
| GET api/Strings/StringData?stringName={stringName}&parentId={parentId}&languageId={languageId} |
No documentation available. |
| GET api/Strings/StringDataGroup?stringNameBase={stringNameBase}&parentId={parentId}&languageId={languageId} |
Return the StringData values based on the Base Name |
Tree
Tree Controller
| API | Description |
|---|---|
| GET api/Tree/GetResourceTree |
Get Resource Tree Used by Panel Admin to select resources for a panel |
| GET api/Tree/Trees |
No documentation available. |
| GET api/Tree/GetRegionsByTreeId?treeId={treeId} |
No documentation available. |
| GET api/Tree |
Get Tree List Returns a list of all trees |
| GET api/Tree?treeId={treeId} |
Get tree list by tree id |
| GET api/Tree?treeName={treeName} |
Get tree list by tree name |
User
| API | Description |
|---|---|
| GET api/User/GetUserSummaryList?searchText={searchText}&pageNumber={pageNumber}&pageSize={pageSize} |
Get RS User Summary List |
| GET api/User/GetUserLocationDefault?userId={userId} |
Return the User's default location information |
| GET api/User/CalculatePermissions?queryType={queryType}&userId={userId} |
No documentation available. |
| GET api/User?searchText={searchText}&pageNumber={pageNumber}&pageSize={pageSize} |
Get All Users |
| GET api/User?userId={userId} |
Get User |
| GET api/User?emailaddress={emailaddress} |
Get a user by email address |
| POST api/User |
Create User Only accessible by Administrative Users Note: To initialize the RSUser object, call GetUser with userId = 0 to retrieve the Default User properties. |
| PUT api/User |
Update User Only accessible by Administrative Users |
| DELETE api/User?userId={userId}&lastModifiedByUserId={lastModifiedByUserId} |
Delete User Only accessible by Administrative Users |
UserProxy
User Proxy Controller
| API | Description |
|---|---|
| GET api/UserProxy?proxyUserId={proxyUserId} |
Get user proxy list by proxy user id Only accessible by Administrative Users |
| GET api/UserProxy?proxyUserEmail={proxyUserEmail} |
Get user proxy list by proxy user email address Only accessible by Administrative Users |
| POST api/UserProxy?userId={userId}&proxyUserId={proxyUserId} |
Add user proxy by user ids Only accessible by Administrative Users |
| POST api/UserProxy?userEmail={userEmail}&proxyUserEmail={proxyUserEmail} |
Add user proxy by email addresses Only accessible by Administrative Users |
| DELETE api/UserProxy?userId={userId}&proxyUserId={proxyUserId} |
Delete user proxy by user ids Only accessible by Administrative Users |
| DELETE api/UserProxy?userEmail={userEmail}&proxyUserEmail={proxyUserEmail} |
Delete user proxy by email addresses Only accessible by Administrative Users |
Utility
Utility Controller
| API | Description |
|---|---|
| GET api/Utility/GetServicesApplicationSettingValue?settingName={settingName} |
Get Services Application Setting Value |
| GET api/Utility/GetApplicationSettingValue?settingName={settingName} |
Get Application Setting Value |
| GET api/Utility?settingName={settingName} |
Get Application Setting Value |
| GET api/Utility/GetApplicationSettingValueV2?settingName={settingName}&instanceId={instanceId} |
Get Application Setting Value By Kiosk Instance Id |
| GET api/Utility/GetApplicationSettingValueV3?settingName={settingName}&applicationId={applicationId} |
Get Application Setting Value By Application Id 1 Kiosk 2 RoomWizard 3 StudyRoomScheduler 4 RSMobile 5 Web Request 6 KioskAdmin 7 ResourceScheduler 8 TouchPanel |
| GET api/Utility/GetApplicationSettingValueV4?settingName={settingName}&applicationId={applicationId}&instanceId={instanceId} |
Get Application Setting Value By Application Id 1 Kiosk 2 RoomWizard 3 StudyRoomScheduler 4 RSMobile 5 Web Request 6 KioskAdmin 7 ResourceScheduler 8 TouchPanel |
| GET api/Utility/GetServicesApplicationSettingValues?settingNameList[0]={settingNameList[0]}&settingNameList[1]={settingNameList[1]} |
Get Services Application Setting Value List Returns specified tbl_control values |
| GET api/Utility/GetApplicationSettingValues?settingNameList[0]={settingNameList[0]}&settingNameList[1]={settingNameList[1]} |
Get Application Setting Value List Returns specified tbl_control values |
| GET api/Utility/GetApplicationSettingGroup?settingNameBase={settingNameBase} |
Get Application Setting Value List Returns specified tbl_control values |
| GET api/Utility/GetApplicationSettingValueList |
Get Application Setting Value List Returns all tbl_control values |
| GET api/Utility/GetResourceSchedulerImage?imageId={imageId} |
Get Resource Scheduler Image The image data (stored as varbinary(max) in the db) is returned as a Hex String along with the File Extension. To save this as an image, it needs to be converted to a byte array and saved as an 'image' object: Remove the first two characters then convert to a Binary Array and save as image. string hexString = "0xFFD8FFE000104A46494600010101005C00580000FFFE001C5........."; string fileExtension = "jpg"; hexString = hexString.Substring(2); byte[] bytes = StringToByteArray(hexString); System.Drawing.Image image; using (MemoryStream ms = new MemoryStream(bytes)) { image = Image.FromStream(ms); image.Save("C:\\myimage." + fileExtension); } |
| GET api/Utility/GetExternalSystemList |
Get External System List |
| GET api/Utility/GetExternalCrossReferenceMapList |
Get External Cross Reference Map List |
| GET api/Utility/GetExternalCrossReferenceMapByExternalSystemId?externalSystemReference={externalSystemReference}&rsEntityType={rsEntityType}&externalSystemId={externalSystemId} |
Get External Cross Reference Map (By External System Id) |
| GET api/Utility/GetExternalCrossReferenceMapByRSEntityId?externalSystemReference={externalSystemReference}&rsEntityType={rsEntityType}&rsEntityId={rsEntityId} |
Get External Cross Reference Map (By RS Entity Id) |
| GET api/Utility/GetOlsonTimeZone/{win32TimeZone} |
Return the Olson Time Zone for the first matching Win32TimeZone name |
| GET api/Utility/GetResourceSchedulerImageRaw?imageId={imageId} |
Get Resouce Scheduler image in raw format |
| GET api/Utility/ConvertFromUtcToTimeZone?dateToConvert={dateToConvert}&win32TimeZone={win32TimeZone} |
Converts a date/time from UTC to specified time zone |
| GET api/Utility/ConvertFromTimeZoneToUtc?dateToConvert={dateToConvert}&win32TimeZone={win32TimeZone} |
Converts a date/time from specified time zone to UTC |
| GET api/Utility/ConvertFromTimeZoneToTimeZone?dateToConvert={dateToConvert}&sourceWin32TimeZone={sourceWin32TimeZone}&destinationWin32TimeZone={destinationWin32TimeZone} |
Converts a date/time from source time zone to destination time zone |
| GET api/Utility/GetLanguageList |
Returns existing languages |
| GET api/Utility |
Get Services Application Setting Value List Returns all tbl_control values |
| GET api/Utility?imageId={imageId}&languageId={languageId} |
Get Resource Scheduler Image V2 |
Version
| API | Description |
|---|---|
| GET api/Version?ssoSettingsId={ssoSettingsId} |
Retrieve version and build date |