Parties
The Parties entity represents a group seated in the venue, and should uniquely identify them in the POS for the entire duration of their stay. Dojo Bookings infers availability by the presence of a party at a table. Each party can include additional details such as deposits, special requests and allergen information.
Capabilities
In the Dojo EPOS Data API, capabilities represent specific actions that the POS system can perform. These capabilities are linked to corresponding API endpoints in the POS system. By defining these capabilities, the POS system communicates to Dojo which features are supported and accessible.
CreateParty
POST REST /v1/parties
This capability allows the creation of a new Party within the POS system. It is essential for assigning parties to a table and storing relevant order details.
GetPartyById
GET REST /v1/parties/{partyId}
This capability allows Dojo to retrieve up-to-date information about a specific party seated at a table, such as the unique ID, table ID and status.
UpdatePartyById
PUT REST /v1/parties/{partyId}
This capability allows Dojo to update the POS with additional party information given after initial booking. For example, this could be the party's allergen requirements in the form of guestRequests, a change in booking time or a new expected end-time.
DeletePartyById
DELETE REST /v1/parties/{partyId}
This capability allows Dojos Epos Data API to delete a specific party by using the party Id.
SearchParties
This capability allows Dojo to retrieve parties from a POS. By default, the POS should not return parties where endTime is set, including them only where completedOnly is "true".