v1Ressourcen/Locations/getStandortgruppen auflisten

Standortgruppen auflisten

Eine Standortgruppe ist eine Reihe von Standorten, die gemeinsam als eine Marke eingetragen werden. Auf Verzeichnissen, die das unterstützen (derzeit Localtunity und die regionalen Websites, die es übernehmen), ist die Gruppe ein Unternehmen mit dem Namen der Gruppe, und jeder Standort erscheint darunter mit seiner eigenen Adresse. Alle anderen Verzeichnisse tragen jeden Standort weiterhin einzeln ein. Nutzen Sie das für eine Kette, meist wenn ihre Standorte eine Telefonnummer teilen, denn diese Verzeichnisse akzeptieren nur einen Eintrag pro Nummer. Liefert jede Gruppe, die der Schlüssel sehen kann, sowie `sites`: die Verzeichnisse, die Gruppen gemeinsam eintragen. Bei einem auf bestimmte Kunden beschränkten Schlüssel umfassen Anzahlen und Kunden-IDs nur diese Kunden; `hiddenLocationCount` zählt den Rest.

get/api/v1/location-groups
locations:read
Query-Parameter
locationIdstringoptional
Nur die Gruppe zurückgeben, in der sich dieser Standort befindet (Standort-ID oder öffentliche ID).
Antwort
dataobjectoptional
groupsarray of objectoptional
idstringoptional
namestringoptional
Der Unternehmensname, unter dem die Standorte auf den Verzeichnissen der Gruppe erscheinen.
locationCountintegeroptional
Standorte der Gruppe, die der Schlüssel sehen kann.
clientIdsarray of stringoptional
Kunden dieser Standorte.
hiddenLocationCountintegeroptional
Standorte der Gruppe, die zu Kunden gehören, auf die der Schlüssel keinen Zugriff hat.
createdAtstringoptional
sitesarray of objectoptional
Verzeichnisse, die Gruppen gemeinsam eintragen.
siteIdintegeroptional
namestringoptional
copiesarray of objectoptional
Regionale Websites, die die Einträge dieses Verzeichnisses übernehmen.
siteIdintegeroptional
namestringoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/location-groups
Ihr API-Schlüssel
locationId
{}

Anleitungen, die diese Ressource verwenden