GetWaitlistEntry-Methode

Diese Methode gibt einen Wartelisteneintrag für einen Nutzer basierend auf der angegebenen ID für den Wartelisteneintrag zurück. Das Actions Center ruft diese in regelmäßigen Abständen auf, um aktuelle Informationen zum Wartelisteneintrag des Nutzers zu erhalten. Wartelisteneinträge sollten ab dem Zeitpunkt ihrer Erstellung 30 Tage lang abrufbar sein.

Anfrage

GetWaitlistEntryRequest

Rückgabewert

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;
}

Beispiele für GetWartelistEntry

Anfrage abrufen

{ "waitlist_entry_id": "MYS-1668739060" }

Antwort erhalten

{
  "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 }
  }
}