Fotos für einen Standort abrufen

Name	Typ	Erforderlich	Beschreibung
locationId	string	erforderlich	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`.

Name

Typ

Erforderlich

Beschreibung

locationId

string

erforderlich

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`.

Antworten

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.

Gibt jede einem Standort zugeordnete Mediendatei zurück: Logo, Titelbild und zusätzliche Bilder, jeweils mit öffentlichen url, thumbnailUrl, Kategorie, der Angabe, ob die Datei starred ist, und einem viewsCount für die gesamte Laufzeit.

Anwendungsfall: Fotogalerie eines Standorts anzeigen. Rufen Sie die Medienliste ab, um die bereits veröffentlichten Bilder eines Unternehmens anzuzeigen, und verwenden Sie dabei thumbnailUrl für die Rasteransicht und url für die Ansicht in voller Größe. starred zeigt Ihnen, welche zusätzlichen Fotos für eine bevorzugte Platzierung auf unterstützten Plattformen angeheftet sind.

Anwendungsfall: Medienabdeckung vor einem Upload prüfen. Rufen Sie zuerst diesen Endpunkt auf, um festzustellen, ob einem Standort ein Bild der Kategorie Logo oder Cover fehlt, und laden Sie anschließend nur die fehlenden Bilder hoch. Die zurückgegebenen id-Werte sind genau die Werte, die Sie an die Endpunkte zum Markieren mit einem Stern und zum Entfernen übergeben.

Stolperfallen.

Jede der ID-Formen funktioniert im Pfad: 1800289, TG9jYXRpb246MTgwMDI4OQ== und TG9jYXRpb246MTgwMDI4OQ%3D%3D verweisen alle auf denselben Standort. Bei einem Wert, der keiner dieser Formen entspricht, gibt der Endpunkt HTTP 200 mit einem errors-Array, das SY90002: Invalid Id enthält, und einer null-Payload zurück.
Für einen Standort ohne Medien wird { "data": { "mediaFilesOfLocation": [] } } zurückgegeben; dies ist die tatsächliche Antwort für einen neu erstellten Standort wie „Jenny Home“ und kein Fehler.

Parameter

Pfad

Antworten