+971 4 437 7574
info@roomoperations.com

API Documentation

Authentication

Endpoint URI
https://< site_url >/api/authenticate

Method : POST

Parameters
grant_type=password&username=username&password=password
Headers : "Content-Type", "application/x-www-form-urlencoded"
"Content-Length", "Byte.length"
"Content-Language", "en-US"


Return Response
Access Token

Housekeeping

Endpoint URI
https://< site_url >api/Schedules/GetScheduleData/

Method : GET

Parameters
EntityID + '/' + Date + '/' + all

Headers : "Authorization", "Bearer " < access_token >

Return Response
JSON Array

JSON Properties

Room Attendants [Array]

Property Description
Id Section No
title
credits Total | Completed | Pending Credits
sectionNo Section Number
sectionName Section Name
housekeeperID Room Attendant ID
rooms List of rooms for Supervisor inspection
supervisorID Supervisor ID
supervisorFN Supervisor First Name

Schedule Data [Array]

Property Description
id Schedule ID
resourceId Return Section Number. Relation between Room Attendant and Schedule Data
title Returns Room Number.
start Returns Schedule Start in Time Format
end Returns Schedule End in Time Format
color Background color, visually defines the rooms status
textcolor Black
moData Consolidate data for room
eventType Guest status. Stay Over, Checked Out, Due Out, Checked In
attendant Guid for the Room Attendant
arrival 1
initStatus Initial Status of the Room.
disStatus Discrepancy Status
Endpoint URI
https://< site_url >api/Schedules/CreateSchedule/

Method : POST

Headers : "Authorization", "Bearer " < access_token >

JSON Properties

Property Description
EntityID
ScheduleDate
ScheduleStart
ScheduleEnd
StartDate
StartTime
EndDate
EndTime
Housekeeper
RoomNo
RoomStatus
FOStatus
ReservationStatus
GuestNationality
GuestTitle
GuestName
GuestVIP
Specials
Instructions
Inspected
Inspector
SectionNo
Endpoint URI
https://< site_url >api/Schedules/UpdateSchedule/

Method : POST

Headers : "Authorization", "Bearer " < access_token >

JSON Properties

Property Description
EntityID
uid
createdDate
ScheduleDate
ScheduleStart
ScheduleEnd
StartDate
StartTime
completedDate
Housekeeper
RoomNo
RoomStatus
FOStatus
ReservationStatus
GuestNationality
GuestTitle
GuestName
GuestVIP
Specials
Instructions
Inspected
Inspector
SectionNo
Endpoint URI
https://< site_url >api/Schedules/DScheduleItem/

Method : POST

Headers : "Authorization", "Bearer " < access_token >

Parameters
EntityID + '/' + uid

Endpoint URI
https://< site_url >api/Schedules/GetHKScheduleData/

Method : GET

Headers : "Authorization", "Bearer " < access_token >

Parameters
EntityID + '/' + UserID

JSON Properties

Property Description
EntityID
UID
RoomNo
RoomStatus
ScheduleDate
ScheduleStart
ScheduleEnd
Credits
ReservationStatus
ScheduledTime
GuestNationality
GuestTitle
GuestName

Parameters

Endpoint URI
https://< site_url >api/users/

Method : GET

Headers : "Authorization", "Bearer " < access_token >

Parameters
EntityID


JSON Properties

Property Description
EntityID
Id
NameSurname
RoleName
Email
PhoneNumber
Endpoint URI
https://< site_url >api/rooms/

Method : GET

Headers : "Authorization", "Bearer " < access_token >

Parameters
EntityID


JSON Properties

Property Description
EntityID
roomID
roomNumber
Endpoint URI
https://< site_url >api/sects/

Method : GET

Headers : "Authorization", "Bearer " < access_token >

Parameters
EntityID


JSON Properties

Property Description
SectionNo
SectionName
Supervisor
Sign Up Now!

Try RoomOperations and find out how it will help you.