Orbitvu Public Support Site

Liste der Präsentationen

Updated

Zurückgegebene Daten

Die von diesem Endpunkt zurückgegebenen Daten sind eine paginierte Liste von Präsentationen und deren Inhalt. Zum Beispiel:

{
    "count": 1,
    "next": null,
    "previous": null,
    "per_page": 50,
    "results": [
        {
            "id": 46,
            "uid": "5Etsw445fEtdGYpKLnTp5b",
            "name": "Some presentation",
            "sku": "1234",
            "category_1": "",
            "category_2": "",
            "create_date": "2013-02-15T09:45:00",
            "ovus_number": "025",
            "presentation_size": 11066632,
            "has_orbittour": true,
            "tags": [],
            "url": "https://orbitvu.co/api/presentations/46",
            "edit_url": "https://orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/",
            "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/img01.png",
            "statistics_url": "https://orbitvu.co/api/v1/presentations/46/statistics",
            "orbittour_set": [
                {
                    "id": 1,
                    "script_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/2/orbittour/1/script",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/2/orbittour/1/view"
                }
            ],
            "custom_attributes": [
                {
                    "label": "Category 1",
                    "value": "summer",
                }
            ],
            "presentationcontent_set": [
                {
                    "id": 117,
                    "sorting_order": 1,
                    "name": "ov3601",
                    "type": 1,
                    "type_display": "ORBITVU 360",
                    "ovus_folder": "https://orbitvu.co/025/5Etsw445fEtdGYpKLnTp5b/ov3601/",
                    "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/img01.png",
                    "script_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/ov3601/3/script",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/ov3601/3/view",
                    "max_width": 4272,
                    "max_height": 2848,
                    "content2_xml": true
                },
                {
                    "id": 119,
                    "sorting_order": 2,
                    "name": "img_1.jpg",
                    "type": 3,
                    "type_display": "image2d",
                    "ovus_folder": "",
                    "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/119/img01.png",
                    "script_url": "",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/119/img01.png",
                    "max_width": 0,
                    "max_height": 0,
                    "content2_xml": ""
                },
                {
                    "id": 120,
                    "sorting_order": 3,
                    "name": "img_2.jpg",
                    "type": 3,
                    "type_display": "image2d",
                    "ovus_folder": "",
                    "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/120/img01.png",
                    "script_url": "",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/120/img01.png",
                    "max_width": 0,
                    "max_height": 0,
                    "content2_xml": ""
                }
            ]
        }
    ]
}

Paginierungsbezogene Daten:

  • count - die Anzahl der Ergebnisse
  • next - URL zur nächsten Seite der Ergebnisse (null, wenn es keine nächste Seite gibt)
  • previous - URL zur vorherigen Seite der Ergebnisse (null, wenn es keine vorherige Seite gibt)
  • per_page - Anzahl der Ergebnisse pro Seite (kann mit dem URL-Parameter page_size festgelegt werden)
  • results - Liste der Ergebnisse (Präsentationsobjekte)

Eine detaillierte Beschreibung der Ergebnisdaten:

  • id - eindeutiger Präsentationsbezeichner (numerisch)
  • uid - eindeutiger Präsentationsbezeichner (wie in URLs verwendet)
  • name, SKU, category_1, category_2 - Angaben zur Präsentation
  • create_date - Erstellungsdatum der Präsentation
  • ovus_number - Nummer, die im Parameter ovus_folder für 360 Inhalte verwendet wird, nützlich für die automatische Erstellung von ovus_folder
  • presentation_size - Größe der Präsentation in Bytes
  • has_orbittour - ein boolescher Wert, der bestimmt, ob es für diese Präsentation eine ORBITTOUR gibt
  • tags - Liste der an die Präsentation angehängten Tags
  • url - direkte URL zu diesem Präsentationsobjekt
  • edit_url - URL zur Bearbeitungsseite der Orbitvu SUN Präsentation
  • thumbnail_url - URL zum Thumbnail-Bild für diese Präsentation; das Bild kann mit Query-String-Parametern manipuliert werden, wie
    • width - gewünschte Breite
    • height - gewünschte Höhe
    • max_width - maximale Breite (behält das Höhenverhältnis bei)
    • max_height - maximale Höhe (behält das Verhältnis zur Breite bei)
    • action - crop (Bild auf die gewünschte Größe zuschneiden), supplement (mit weißem Hintergrund ergänzen, um die gewünschte Größe zu erhalten)
  • statistics_url - URL zu den Präsentationsstatistiken
  • orbittour_set - Liste der für die Präsentation definierten ORBITTOURs (derzeit bis zu einer ORBITTOUR)
  • presentationcontent_set - Liste der Präsentationsinhalte:
    • id - eindeutige ID des Präsentationsinhalts
    • sorting_order - eine Zahl, die die Reihenfolge der Inhalte angibt
    • name - ein Name für den Inhalt, z.B. ov3601 für 360 Inhalte oder Dateiname für 2D Bildinhalte
    • type - Art des Inhalts: 1 - 360°-Inhalt, 3 - 2D-Bild, 4 - Video
    • type_display - benutzerfreundliche Beschreibung des Inhaltstyps
    • ovus_folder - ovus_folder URL für 360°-Darstellung; leer für 2D-Inhalte
    • thumbnail_url - URL zum Bild (für 2D-Inhalte) oder zum Thumbnail (für 360°-Inhalte). Das Bild kann mit Query-String-Parametern geändert werden (wie oben beschrieben)
    • script_url - URL zum Skript-Endpunkt für 360°-Inhalte
    • view_url - URL zum Endpunkt der Ansicht für 360°-Inhalte
    • max_width - maximale Breite des 360°-Inhalts
    • max_height - Maximale Höhe des 360°-Inhalts
    • content2_xml - Boolescher Wert, der bestimmt, ob 360°-Inhalte die Datei content2.xml verwenden

Suche

  • Genau - Suche nach Präsentationen durch exakte Übereinstimmung mit bestimmten Feldern: id, sku, name, uid, tags, z. B.:
# match presentation with sku == 1234
https://orbitvu.co/api/v1/presentations.json?sku=1234

# match presentation with tag shoes
https://orbitvu.co/api/v1/presentations.json?tags=shoes
  • Nach Erstellungsdatum - Suche nach Präsentationen nach Datumsbereich mit: create_date_from and/or create_date_to and date format: YYYY-MM-DD, z.B.:
# Search for presentations created after 2018-01-05: https://orbitvu.co/api/v1/presentations.json?create_date_from=2018-01-05

# Search for presentations created between 2018-01-01 and 2018-01-05: 
https://orbitvu.co/api/v1/presentations.json?create_date_from=2018-01-01&create_date_to=2018-01-05
  • ilike - Suche nach Präsentationen, die ein bestimmtes Muster in bestimmten Feldern enthalten: search_sku, search_name, search_uid, search_tags:
# match all presentations with sku containing '123'
https://orbitvu.co/api/v1/presentations?search_sku=123

# match all presentations with tags like 'tag1' or 'tag2'
https://orbitvu.co/api/v1/presentations?search_tags=tag1,tag2
  • ilike - Suche in mehreren Feldern auf einmal
    Suche nach Präsentationen, die ein bestimmtes Muster in einem der folgenden Felder enthalten sku, name, uid:
# match all presentations with sku, name or uid containing 'A123' or 'a123'
https://orbitvu.co/api/v1/presentations?search=A123

Sortierung

Sortiert nach: sku, uid, name:

# ascending
https://orbitvu.co/api/v1/presentations?ordering=sku

# descending
https://orbitvu.co/api/v1/presentations?ordering=-sku

Paginierung

Anzahl der Präsentationen pro Seite:

https://orbitvu.co/api/v1/presentations/?page_size=5
Previous Article Format der Daten
Next Article Details der Präsentation
Still Need Help? Contact Us