ListBookings method
Stay organized with collections
Save and categorize content based on your preferences.
Request
ListBookingsRequest
Return value
ListBookingsResponse
This only needs to return future bookings for a user, not bookings for all time.
Canonical gRPC error codes
NOT_FOUND (if the requested user ID is unknown to the partner)
// Request to list all upcoming bookings for a user
message ListBookingsRequest {
// ID of the user (required)
string user_id = 1;
}
// Response for the [ext.maps.booking.partner.v2.ListBookings] RPC with all
// upcoming bookings for the requested user
message ListBookingsResponse {
// All bookings of the user (required)
repeated Booking bookings = 1;
}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-20 UTC.
[null,null,["Last updated 2025-05-20 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eListBookings\u003c/code\u003e RPC retrieves upcoming bookings for a specific user.\u003c/p\u003e\n"],["\u003cp\u003eRequests must include the user's ID and will return a \u003ccode\u003eNOT_FOUND\u003c/code\u003e error if the ID is unknown.\u003c/p\u003e\n"],["\u003cp\u003eThe response contains a list of \u003ccode\u003eBooking\u003c/code\u003e objects representing the user's future bookings.\u003c/p\u003e\n"]]],["The `ListBookingsRequest` requires a `user_id` to retrieve a user's future bookings. The `ListBookingsResponse` returns a list of `bookings` for the specified user. The system should only return future bookings, not historical ones. If the provided `user_id` is not found, the service will respond with a `NOT_FOUND` gRPC error code. The request is made through the `ListBookings` RPC.\n"],null,["# ListBookings method\n\n**Request**\n\nListBookingsRequest\n\n**Return value**\n\nListBookingsResponse\n\nThis only needs to return future bookings for a user, not bookings for all time.\n\n**Canonical gRPC error codes**\n\n- `NOT_FOUND` (if the requested user ID is unknown to the partner)\n\n```scilab\n// Request to list all upcoming bookings for a user\nmessage ListBookingsRequest {\n // ID of the user (required)\n string user_id = 1;\n}\n\n// Response for the [ext.maps.booking.partner.v2.ListBookings] RPC with all\n// upcoming bookings for the requested user\nmessage ListBookingsResponse {\n // All bookings of the user (required)\n repeated Booking bookings = 1;\n}\n```"]]