De API voor kassasysteem is te vinden op: https://pos.mijnreservering.info/wcf/XmlPosService.svc.
Voor alle methodes geldt dat als de call mislukt om wat voor reden dan ook er een response wordt teruggegeven met 'Success = false' en bevat deze een gevulde ErrorMessage.
| Methode | AuthenticateUser |
| Parameters | AuthenticationRequest - UserName: Gebruikersnaam ontvangen van Bookzo. - Password: Wachtwoord ontvangen van Bookzo. |
| Result | AuthenticationResponse - Token: Token die gebruikt kan worden om vervolgmethodes aan te roepen. Het token is 1 uur geldig. |
| Beschrijving | Methode aanroepen met de gegevens die per park opgevraagd kunnen worden bij Bookzo. Er wordt een response teruggeven met een token, dit token kan in de andere methodes worden meegegeven. Het token is 1 uur geldig, daarna moet een nieuw token worden opgevraagd. |
| Methode | VerifyRoom | ||||||||||||
| Parameters | Authentication - Token: Token ontvangen vanuit de 'AuthenticateUser' methode. VerifyRoomRequest - Value: Waarde waarop gezocht moet worden. - RoomVerifyType:
| ||||||||||||
| Result | VerifyRoomResponse - Reservations: Lijst van reserveringen die voldoen aan de opgegeven criteria. Reservation - ReservationNumber - Reserveringsnummer. - Roomnumber - Kamernummer. - IsChargeAllowed - True als de betaling op kamer geboekt mag worden, anders false. - CreditLimit - Wordt momenteel niet gebruikt door bookzo. - Guests - Lijst met gasten die in de kamer verblijven. | ||||||||||||
| Beschrijving | Aan te roepen op het moment dat de betaling door de gast wordt gedaan. In het geval van een contante verkoop aanroepen met RoomVerifyType: CashAccount zodat de omzet op de contante verkoopaccommodatie geboekt kan worden. Bij een betaling via het PMS aanroepen met RoomVerifyType:Name en de zoekwaarde ingevoerd door de kassamedewerker. Bookzo geeft dan een lijst van reserveringen terug waaruit de kassamedewerker een keuze moet maken. |
| Methode | ChargeRoom |
| Parameters | Authentication - Token: Token ontvangen vanuit de 'AuthenticateUser' methode. ChargeRoomRequest - ReservationNumber: Reserveringsnummer waarop de tickets geboekt moeten worden - TicketNumber: Ticketnummer uit het kassasysteem - PosDate: Boekdatum uit het kassasysteem - TicketDetails: Lijst met ticketdetails van de genuttigde items TicketDetail - Quantity: Aantal - Amount: Eenheidprijs in centen. - RevenueGroup: Omzetgroep tbv koppeling bookzo (In Bookzo kunnen ze de Revenuegroup aan een extra kosten koppelen). - Description: Omschrijving van de regel - Overige eigenschappen worden niet gebruikt. |
| Result | ChargeRoomResponse - ReservationNumber: Reserveringnummer waarop geboekt is - TicketNumber: Ticketnummer waarop geboekt is |
| Beschrijving | Aan te roepen op het moment dat de betaling definitief naar Bookzo doorgeboekt moet worden met het gekozen reserveringsnummer (verkregen via VerifyRoom met Type Name of CashAccount). De tickets staan na een success result in Bookzo. |