BokaMera.API.Host

<back to all web services

GetMyBookingReservations

Requires Authentication
The following routes are available for this service:
GET/bookingreservations/mineList the caller's own awaiting-payment reservationsReturns the logged-in customer's reservations that are still awaiting payment (committed but not yet paid/converted) so they can resume payment from their bookings list. Scoped to the caller's customer within the company; expired holds are excluded.
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    public static class GetMyBookingReservations implements ICompany
    {
        /**
        * The company id, if empty will use the company id for the user you are logged in with.
        */
        @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        public UUID CompanyId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public GetMyBookingReservations setCompanyId(UUID value) { this.CompanyId = value; return this; }
    }

    public static class MyBookingReservationsResponse
    {
        /**
        * The caller's awaiting-payment reservations.
        */
        @ApiMember(Description="The caller's awaiting-payment reservations.")
        public ArrayList<MyBookingReservationResult> Results = new ArrayList<MyBookingReservationResult>();

        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<MyBookingReservationResult> getResults() { return Results; }
        public MyBookingReservationsResponse setResults(ArrayList<MyBookingReservationResult> value) { this.Results = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public MyBookingReservationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class MyBookingReservationResult
    {
        /**
        * The opaque session key that identifies the reservation.
        */
        @ApiMember(Description="The opaque session key that identifies the reservation.")
        public UUID SessionKey = null;

        /**
        * The reserved service id.
        */
        @ApiMember(Description="The reserved service id.")
        public Integer ServiceId = null;

        /**
        * The reserved service name.
        */
        @ApiMember(Description="The reserved service name.")
        public String ServiceName = null;

        /**
        * The reservation start.
        */
        @ApiMember(Description="The reservation start.")
        public Date From = null;

        /**
        * The reservation end.
        */
        @ApiMember(Description="The reservation end.")
        public Date To = null;

        /**
        * Number of reserved spots.
        */
        @ApiMember(Description="Number of reserved spots.")
        public Integer NumberOfBookedSpots = null;

        /**
        * When the hold expires (company-local time).
        */
        @ApiMember(Description="When the hold expires (company-local time).")
        public Date ExpirationDatetime = null;

        /**
        * The company's current time, in the same frame as ExpirationDatetime.
        */
        @ApiMember(Description="The company's current time, in the same frame as ExpirationDatetime.")
        public Date ServerTime = null;

        /**
        * The BookingReservationStatus value (AwaitingPayment).
        */
        @ApiMember(Description="The BookingReservationStatus value (AwaitingPayment).")
        public Integer StatusCode = null;

        /**
        * The BookingReservationStatus name.
        */
        @ApiMember(Description="The BookingReservationStatus name.")
        public String StatusName = null;

        /**
        * The currency of the reservation, if resolved.
        */
        @ApiMember(Description="The currency of the reservation, if resolved.")
        public String CurrencyId = null;

        /**
        * The payable reference to use as the checkout InternalReferenceId when resuming payment.
        */
        @ApiMember(Description="The payable reference to use as the checkout InternalReferenceId when resuming payment.")
        public String InternalReferenceId = null;
        
        public UUID getSessionKey() { return SessionKey; }
        public MyBookingReservationResult setSessionKey(UUID value) { this.SessionKey = value; return this; }
        public Integer getServiceId() { return ServiceId; }
        public MyBookingReservationResult setServiceId(Integer value) { this.ServiceId = value; return this; }
        public String getServiceName() { return ServiceName; }
        public MyBookingReservationResult setServiceName(String value) { this.ServiceName = value; return this; }
        public Date getFrom() { return From; }
        public MyBookingReservationResult setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public MyBookingReservationResult setTo(Date value) { this.To = value; return this; }
        public Integer getNumberOfBookedSpots() { return NumberOfBookedSpots; }
        public MyBookingReservationResult setNumberOfBookedSpots(Integer value) { this.NumberOfBookedSpots = value; return this; }
        public Date getExpirationDatetime() { return ExpirationDatetime; }
        public MyBookingReservationResult setExpirationDatetime(Date value) { this.ExpirationDatetime = value; return this; }
        public Date getServerTime() { return ServerTime; }
        public MyBookingReservationResult setServerTime(Date value) { this.ServerTime = value; return this; }
        public Integer getStatusCode() { return StatusCode; }
        public MyBookingReservationResult setStatusCode(Integer value) { this.StatusCode = value; return this; }
        public String getStatusName() { return StatusName; }
        public MyBookingReservationResult setStatusName(String value) { this.StatusName = value; return this; }
        public String getCurrencyId() { return CurrencyId; }
        public MyBookingReservationResult setCurrencyId(String value) { this.CurrencyId = value; return this; }
        public String getInternalReferenceId() { return InternalReferenceId; }
        public MyBookingReservationResult setInternalReferenceId(String value) { this.InternalReferenceId = value; return this; }
    }

}

Java GetMyBookingReservations DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bookingreservations/mine HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			ServiceId: 0,
			ServiceName: String,
			NumberOfBookedSpots: 0,
			StatusCode: 0,
			StatusName: String,
			CurrencyId: String,
			InternalReferenceId: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}