GetWaitlistEntry-Methode

Diese Methode gibt einen Wartelisteneintrag für einen Nutzer anhand der angegebenen Wartelisteneintrag-ID zurück. Das Actions Center ruft diese Funktion regelmäßig auf, um Updates zum Eintrag des Nutzers auf der Warteliste zu erhalten. Wartelisteneinträge sollten ab dem Zeitpunkt ihrer Erstellung 30 Tage lang abrufbar sein.

Ersuchen

GetWaitlistEntryRequest

Rückgabewert

GetWaitlistEntryResponse

// Get the waitlist entry corresponding to the provided waitlist entry ID.
message GetWaitlistEntryRequest {
  option features.(pb.java).nest_in_file_class = YES;

  // 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 {
  option features.(pb.java).nest_in_file_class = YES;

  // Required. The partner-provided information about a user’s waitlist entry.
  WaitlistEntry waitlist_entry = 1;
}

GetWaitlistEntry-Beispiele

Anfrage erhalten

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