v1Recursos/Locations/getListar grupos de ubicaciones

Listar grupos de ubicaciones

Un grupo de ubicaciones es un conjunto de ubicaciones publicadas juntas como una sola marca. En los directorios que lo admiten (hoy Localtunity y los sitios regionales que lo copian), el grupo es un solo negocio con el nombre del grupo, y cada ubicación aparece debajo con su propia dirección. Los demás directorios siguen publicando cada ubicación por separado. Úselo para una cadena, sobre todo cuando sus ubicaciones comparten número de teléfono, porque esos directorios aceptan una sola ficha por número. Devuelve cada grupo que la clave puede ver, más `sites`: los directorios que publican grupos juntos. Con una clave limitada a algunos clientes, los recuentos y los ids de cliente cubren solo esos clientes; `hiddenLocationCount` cuenta el resto.

get/api/v1/location-groups
locations:read
Parámetros de consulta
locationIdstringopcional
Devolver solo el grupo en el que está esta ubicación (id o id público de la ubicación).
Respuesta
dataobjectopcional
groupsarray of objectopcional
idstringopcional
namestringopcional
El nombre del negocio con el que aparecen las ubicaciones en los directorios que publican el grupo.
locationCountintegeropcional
Ubicaciones del grupo que la clave puede ver.
clientIdsarray of stringopcional
Clientes de esas ubicaciones.
hiddenLocationCountintegeropcional
Ubicaciones del grupo de clientes a los que la clave no tiene acceso.
createdAtstringopcional
sitesarray of objectopcional
Directorios que publican grupos juntos.
siteIdintegeropcional
namestringopcional
copiesarray of objectopcional
Sitios regionales que vuelven a publicar las fichas de este directorio.
siteIdintegeropcional
namestringopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/location-groups
Su clave de API
locationId
{}

Guías que usan este recurso