Skip to main content

LocalizedAssetUrls

Media asset URLs localized for a specific language.

bpoJpgImperial object[]

URLs to imperial BPO (Branded Property Overview) JPG pages

  • Array [
  • pageinteger

    Page number (1-indexed)

    Example: 1
    urlstring

    URL to the BPO JPG page image

    Example: https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en_1.jpg
  • ]
  • bpoJpgMetric object[]

    URLs to metric BPO (Branded Property Overview) JPG pages

  • Array [
  • pageinteger

    Page number (1-indexed)

    Example: 1
    urlstring

    URL to the BPO JPG page image

    Example: https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en_1.jpg
  • ]
  • bpoJpgZipImperialstring

    URL to the imperial BPO (Branded Property Overview) JPG ZIP

    Example: https://youriguide.com/api-docs-sample/doc/branded_property_overview_imperial_en.zip
    bpoJpgZipMetricstring

    URL to the metric BPO (Branded Property Overview) JPG ZIP

    Example: https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en.zip
    bpoPdfImperialstring

    URL to the imperial BPO (Branded Property Overview) PDF

    Example: https://youriguide.com/api-docs-sample/doc/branded_property_overview_imperial_en.pdf
    bpoPdfMetricstring

    URL to the metric BPO (Branded Property Overview) PDF

    Example: https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en.pdf
    dxfZipstring

    URL to the DXF floorplans ZIP

    Example: https://youriguide.com/api-docs-sample/doc/dxf_metric.zip
    embedImagestring

    URL to the embed preview image

    Example: https://youriguide.com/api-docs-sample/doc/embed_preview.jpg
    galleryFrontImagestring

    URL to the gallery front image

    Example: https://youriguide.com/api-docs-sample/doc/gallery_front.jpg
    galleryLowResZipstring

    URL to the low-resolution gallery ZIP

    Example: https://youriguide.com/api-docs-sample/doc/gallery-low-res_en.zip
    galleryMlsZipstring

    URL to the MLS-ready gallery ZIP (deprecated, same as galleryLowResZip)

    Example: https://youriguide.com/api-docs-sample/doc/gallery-low-res_en.zip
    galleryZipstring

    URL to the high-resolution gallery ZIP

    Example: https://youriguide.com/api-docs-sample/doc/gallery_en.zip
    jpgImperial object[]

    URLs to imperial JPEG floorplans per floor

  • Array [
  • floorNamestring

    Human-readable floor name

    Example: 1st Floor
    idinteger

    Floor identifier

    Example: 1
    urlstring

    URL to the JPEG floorplan image

    Example: https://youriguide.com/api-docs-sample/doc/floor_metric_en_1.jpg
  • ]
  • jpgMetric object[]

    URLs to metric JPEG floorplans per floor

  • Array [
  • floorNamestring

    Human-readable floor name

    Example: 1st Floor
    idinteger

    Floor identifier

    Example: 1
    urlstring

    URL to the JPEG floorplan image

    Example: https://youriguide.com/api-docs-sample/doc/floor_metric_en_1.jpg
  • ]
  • offlineZipstring

    URL to the offline viewer ZIP (not available for Express iGUIDEs)

    Example: https://youriguide.com/api-docs-sample/doc/offline_en.zip
    pdfImperialstring

    URL to the imperial PDF floorplan

    Example: https://youriguide.com/api-docs-sample/doc/floorplan_imperial_en.pdf
    pdfMetricstring

    URL to the metric PDF floorplan

    Example: https://youriguide.com/api-docs-sample/doc/floorplan_metric_en.pdf
    sphereZipstring

    URL to the sphere images ZIP

    Example: https://youriguide.com/api-docs-sample/doc/spheres.zip
    svgZipstring

    URL to the SVG floorplans ZIP

    Example: https://youriguide.com/api-docs-sample/doc/svg_en.zip
    tagPdfImperialstring

    URL to the imperial Tag Report PDF

    Example: https://youriguide.com/api-docs-sample/doc/tag_floorplan_imperial_en.pdf
    tagPdfMetricstring

    URL to the metric Tag Report PDF

    Example: https://youriguide.com/api-docs-sample/doc/tag_floorplan_metric_en.pdf
    LocalizedAssetUrls
    {
    "bpoJpgImperial": [
    {
    "page": 1,
    "url": "https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en_1.jpg"
    }
    ],
    "bpoJpgMetric": [
    {
    "page": 1,
    "url": "https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en_1.jpg"
    }
    ],
    "bpoJpgZipImperial": "https://youriguide.com/api-docs-sample/doc/branded_property_overview_imperial_en.zip",
    "bpoJpgZipMetric": "https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en.zip",
    "bpoPdfImperial": "https://youriguide.com/api-docs-sample/doc/branded_property_overview_imperial_en.pdf",
    "bpoPdfMetric": "https://youriguide.com/api-docs-sample/doc/branded_property_overview_metric_en.pdf",
    "dxfZip": "https://youriguide.com/api-docs-sample/doc/dxf_metric.zip",
    "embedImage": "https://youriguide.com/api-docs-sample/doc/embed_preview.jpg",
    "galleryFrontImage": "https://youriguide.com/api-docs-sample/doc/gallery_front.jpg",
    "galleryLowResZip": "https://youriguide.com/api-docs-sample/doc/gallery-low-res_en.zip",
    "galleryMlsZip": "https://youriguide.com/api-docs-sample/doc/gallery-low-res_en.zip",
    "galleryZip": "https://youriguide.com/api-docs-sample/doc/gallery_en.zip",
    "jpgImperial": [
    {
    "floorName": "1st Floor",
    "id": 1,
    "url": "https://youriguide.com/api-docs-sample/doc/floor_metric_en_1.jpg"
    }
    ],
    "jpgMetric": [
    {
    "floorName": "1st Floor",
    "id": 1,
    "url": "https://youriguide.com/api-docs-sample/doc/floor_metric_en_1.jpg"
    }
    ],
    "offlineZip": "https://youriguide.com/api-docs-sample/doc/offline_en.zip",
    "pdfImperial": "https://youriguide.com/api-docs-sample/doc/floorplan_imperial_en.pdf",
    "pdfMetric": "https://youriguide.com/api-docs-sample/doc/floorplan_metric_en.pdf",
    "sphereZip": "https://youriguide.com/api-docs-sample/doc/spheres.zip",
    "svgZip": "https://youriguide.com/api-docs-sample/doc/svg_en.zip",
    "tagPdfImperial": "https://youriguide.com/api-docs-sample/doc/tag_floorplan_imperial_en.pdf",
    "tagPdfMetric": "https://youriguide.com/api-docs-sample/doc/tag_floorplan_metric_en.pdf"
    }