GetWaitlistEntry method

This method returns a waitlist entry for a user based on the provided waitlist entry id. The Actions Center will call this periodically to get updates on the user's waitlist entry. Waitlist entries should be retrievable for 30 days from their creation time.

Request

GetWaitlistEntryRequest

Return value

GetWaitlistEntryResponse

// Get the waitlist entry corresponding to the provided waitlist entry ID.
message GetWaitlistEntryRequest {
  // Required. The partner-provided waitlist entry ID to request info for.
  string waitlist_entry_id = 1;
}

// Response with the waitlist entry corresponding to the provided
// waitlist entry ID.
message GetWaitlistEntryResponse {
  // Required. The partner-provided information about a user’s waitlist entry.
  WaitlistEntry waitlist_entry = 1;
}

GetWaitlistEntry samples

{ "waitlist_entry_id": "MYS-1668739060" }

{
  "waitlist_entry": {
    "wait_estimate": {
      "party_size": 3,
      "wait_length": { "parties_ahead_count": 3 }
    },
    "waitlist_entry_state": "WAITING",
    "waitlist_entry_state_times": { "created_time_seconds": 1234567890 }
  }
}