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 'package:servicestack/servicestack.dart';

class MyBookingReservationResult implements IConvertible
{
    /**
    * The opaque session key that identifies the reservation.
    */
    // @ApiMember(Description="The opaque session key that identifies the reservation.")
    String SessionKey = "";

    /**
    * The reserved service id.
    */
    // @ApiMember(Description="The reserved service id.")
    int ServiceId = 0;

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

    /**
    * The reservation start.
    */
    // @ApiMember(Description="The reservation start.")
    DateTime From = DateTime(0);

    /**
    * The reservation end.
    */
    // @ApiMember(Description="The reservation end.")
    DateTime To = DateTime(0);

    /**
    * Number of reserved spots.
    */
    // @ApiMember(Description="Number of reserved spots.")
    int NumberOfBookedSpots = 0;

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

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

    /**
    * The BookingReservationStatus value (AwaitingPayment).
    */
    // @ApiMember(Description="The BookingReservationStatus value (AwaitingPayment).")
    int StatusCode = 0;

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

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

    /**
    * 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.")
    String InternalReferenceId = "";

    MyBookingReservationResult({this.SessionKey,this.ServiceId,this.ServiceName,this.From,this.To,this.NumberOfBookedSpots,this.ExpirationDatetime,this.ServerTime,this.StatusCode,this.StatusName,this.CurrencyId,this.InternalReferenceId});
    MyBookingReservationResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SessionKey = json['SessionKey'];
        ServiceId = json['ServiceId'];
        ServiceName = json['ServiceName'];
        From = JsonConverters.fromJson(json['From'],'DateTime',context!);
        To = JsonConverters.fromJson(json['To'],'DateTime',context!);
        NumberOfBookedSpots = json['NumberOfBookedSpots'];
        ExpirationDatetime = JsonConverters.fromJson(json['ExpirationDatetime'],'DateTime',context!);
        ServerTime = JsonConverters.fromJson(json['ServerTime'],'DateTime',context!);
        StatusCode = json['StatusCode'];
        StatusName = json['StatusName'];
        CurrencyId = json['CurrencyId'];
        InternalReferenceId = json['InternalReferenceId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SessionKey': SessionKey,
        'ServiceId': ServiceId,
        'ServiceName': ServiceName,
        'From': JsonConverters.toJson(From,'DateTime',context!),
        'To': JsonConverters.toJson(To,'DateTime',context!),
        'NumberOfBookedSpots': NumberOfBookedSpots,
        'ExpirationDatetime': JsonConverters.toJson(ExpirationDatetime,'DateTime',context!),
        'ServerTime': JsonConverters.toJson(ServerTime,'DateTime',context!),
        'StatusCode': StatusCode,
        'StatusName': StatusName,
        'CurrencyId': CurrencyId,
        'InternalReferenceId': InternalReferenceId
    };

    getTypeName() => "MyBookingReservationResult";
    TypeContext? context = _ctx;
}

class MyBookingReservationsResponse implements IConvertible
{
    /**
    * The caller's awaiting-payment reservations.
    */
    // @ApiMember(Description="The caller's awaiting-payment reservations.")
    List<MyBookingReservationResult> Results = [];

    ResponseStatus ResponseStatus;

    MyBookingReservationsResponse({this.Results,this.ResponseStatus});
    MyBookingReservationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Results = JsonConverters.fromJson(json['Results'],'List<MyBookingReservationResult>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Results': JsonConverters.toJson(Results,'List<MyBookingReservationResult>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "MyBookingReservationsResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class GetMyBookingReservations implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    GetMyBookingReservations({this.CompanyId});
    GetMyBookingReservations.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId
    };

    getTypeName() => "GetMyBookingReservations";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'MyBookingReservationResult': TypeInfo(TypeOf.Class, create:() => MyBookingReservationResult()),
    'MyBookingReservationsResponse': TypeInfo(TypeOf.Class, create:() => MyBookingReservationsResponse()),
    'List<MyBookingReservationResult>': TypeInfo(TypeOf.Class, create:() => <MyBookingReservationResult>[]),
    'GetMyBookingReservations': TypeInfo(TypeOf.Class, create:() => GetMyBookingReservations()),
});

Dart GetMyBookingReservations DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MyBookingReservationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <MyBookingReservationResult>
      <CurrencyId>String</CurrencyId>
      <ExpirationDatetime>0001-01-01T00:00:00</ExpirationDatetime>
      <From>0001-01-01T00:00:00</From>
      <InternalReferenceId>String</InternalReferenceId>
      <NumberOfBookedSpots>0</NumberOfBookedSpots>
      <ServerTime>0001-01-01T00:00:00</ServerTime>
      <ServiceId>0</ServiceId>
      <ServiceName>String</ServiceName>
      <SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
      <StatusCode>0</StatusCode>
      <StatusName>String</StatusName>
      <To>0001-01-01T00:00:00</To>
    </MyBookingReservationResult>
  </Results>
</MyBookingReservationsResponse>