Orbitvu Public Support Site / / API V1 Reference

Presentations list

Updated on Nov 06, 2019

URL: https://orbitvu.co/api/v1/presentations [.json|.xml]

Returned data

Data returned by this endpoint is a paginated list of presentations and its contents. For example:

{
    "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": ""
                }
            ]
        }
    ]
}

Pagination related data:

count - the number of results
next - URL to next page of results (null if there is no next page)
previous - URL to the previous page of results (null if there is no previous page)
per_page - number of results per page (can be set with page_size URL parameter)
results - list of results (presentation objects)

A detailed description of the results data:

id - unique presentation identifier (numerical)
uid - unique presentation identifier (as used in URLs)
name, SKU, category_1, category_2 - presentation details
create_date - creation date of the presentation
ovus_number - a number that is used within ovus_folder parameter for 360 content, useful for automated generation of ovus_folder
presentation_size - the size of the presentation in bytes
has_orbittour - a boolean value that determines if there is ORBITTOUR for this presentation
tags - list of tags attached to the presentation
url - direct URL to this presentation object
edit_url - URL to Orbitvu SUN presentation edit page
thumbnail_url - URL to the thumbnail image for this presentation; the image can be manipulated with query string parameters like:
- width - requested width
- height - requested height
- max_width - max-width (keeps height proportion)
- max_height - max-height (keeps width proportion)
- action - crop (crop image to the specific size), supplement (supplement with a white background to get the desired size)
statistics_url - URL to presentation statistics
orbittour_set - list of ORBITTOURs defined for presentation (currently up to one ORBITTOUR)
custom_attributes - list of custom attributes defined for the presentation
presentationcontent_set - list of presentation contents:
- id - unique id of presentation content
- sorting_order - a number that represents the ordering of content
- name - a name of the content, will be ov3601 for 360 content or filename for 2D image content
- type - type of content: 1 - 360° content, 2 - image 2D
- type_display - user-friendly description of content type
- ovus_folder - ovus_folder URL for 360° presentation; empty for 2D content
- thumbnail_url - URL to the image (for 2D content) or to thumbnail (for 360° content). Image can be changed with query string parameters (as described above)
- script_url - URL to the script endpoint for 360° content
- view_url - URL to the view endpoint for 360° content
- max_width - max width of 360° content
- max_height - max height of 360° content
- content2_xml - boolean that determines if 360° content uses content2.xml file

Searching

exact

Search for presentations by exact match to specific fields: id, sku, name, uid, tags, eg.:

# 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

by create_date
Search for presentations by date range using: create_date_from and/or create_date_to and date format: YYYY-MM-DD, eg.:

# 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

Search for presentations containing specific pattern within specific fields: 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 - search within multiple fields at once

Search for presentations containing specific pattern within one of sku, name, uid:

# match all presentations with sku, name or uid containing 'A123' or 'a123'
https://orbitvu.co/api/v1/presentations?search=A123

Ordering

Order by: sku, uid, name:

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

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

Pagination

Number of presentations per page:

https://orbitvu.co/api/v1/presentations/?page_size=5

Presentations list

Returned data

Searching

Ordering

Pagination

Other Resources