Obtenir les photos d’un établissement

Nom	Type	Obligatoire	Description
locationId	string	obligatoire	The location's Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). The raw numeric database ID (`1800289`) is also accepted, and so is a percent-encoded value such as `...%3D%3D`.

Nom

Type

Obligatoire

Description

locationId

string

obligatoire

The location's Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). The raw numeric database ID (`1800289`) is also accepted, and so is a percent-encoded value such as `...%3D%3D`.

Réponses

200Array of media files for the location. Returns an empty array when the location has no photos.

Response

{  "data": {    "mediaFilesOfLocation": [      {        "id": "TWVkaWFGaWxlOjU4Nzg5MzE=",        "url": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/f47d62a6.jpg",        "thumbnailUrl": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_f47d62a6.jpg",        "categoryName": "Logo",        "categoryId": "4",        "fileType": "image",        "starred": false,        "viewsCount": 0      },      {        "id": "TWVkaWFGaWxlOjU4Nzg5MzI=",        "url": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/ef4ffb12.jpg",        "thumbnailUrl": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_ef4ffb12.jpg",        "categoryName": "Additional",        "categoryId": "12",        "fileType": "image",        "starred": true,        "viewsCount": 143      }    ]  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Renvoie chaque fichier multimédia associé à un établissement : logo, couverture et images supplémentaires, avec pour chaque fichier son url public, son thumbnailUrl, sa catégorie, une indication précisant s’il est starred et un viewsCount sur toute sa durée de vie.

Cas d’utilisation : afficher la galerie de photos d’un établissement. Récupérez la liste des fichiers multimédias pour afficher les images qu’une entreprise a déjà en ligne, en utilisant thumbnailUrl pour la grille et url pour l’affichage en taille réelle. starred vous indique quelles photos supplémentaires sont épinglées pour bénéficier d’un placement prioritaire sur les plateformes de publication qui prennent en charge cette fonctionnalité.

Cas d’utilisation : vérifier la couverture multimédia avant un téléversement. Appelez d’abord cet endpoint pour vérifier s’il manque à un établissement une image de catégorie Logo ou Cover, puis téléversez uniquement ce qui manque. Les valeurs id renvoyées sont exactement celles que vous transmettez aux endpoints de marquage d’une étoile et de suppression.

Points de vigilance.

Les différentes formes d’id fonctionnent dans le chemin : 1800289, TG9jYXRpb246MTgwMDI4OQ== et TG9jYXRpb246MTgwMDI4OQ%3D%3D désignent toutes le même établissement. Une valeur qui ne correspond à aucune de ces formes entraîne le renvoi du statut HTTP 200 avec un tableau errors contenant SY90002: Invalid Id et une charge utile null.
Un établissement sans fichiers multimédias renvoie { "data": { "mediaFilesOfLocation": [] } } ; il s’agit de la réponse réelle pour un établissement nouvellement créé tel que « Jenny Home », et non d’une erreur.

Obtenir les photos d’un établissement

Paramètres

Chemin

Réponses