eCollection 2.0 Third Party Contribution Data

To integrate third party data into the eCollection you have to provide:

  • Room images (16:9, at least 1920x1080px)
  • Article scans (16:9, at least 1920x1080px)
  • Article preview images (~1:1, at least 160x160px)
  • An XML file describing each article and assigning it to a collection and the images.

The XML file will be uploaded via SFTP on our server. Images must will either be uploaded via SFTP or referenced by HTTP/HTTPS.

Codelists

Schema

Currently we do not provide a DTD or XSD file to validate the XML data. Please adapt the following example instead:

<?xml version="1.0"?>
<ecollection>
    <!--
    // Example XML file for eCollection third party data. 
    //
    // All texts have to be encoded in UTF-8.
    //
    // All images must be filenames relative to the XML file, or HTTP/HTTPS urls
    // where the images can be downloaded from. The webserver should support
    // the HTTP If-Modified-Since header and respond with 204 Not Modified
    // if the image has not changed.
    //
    // The "cardinality" tells how often an element may be repeated within each parent:
    //
    //   - "1" means the element is required
    //   - "1..n" means the element is required but may be repeated multiple 
    //            times with different contents
    //   - "0..1" means the element is Optional
    //   - "0..n" means the element is optional but may be repeated multiple 
    //            times with different contents
    //
    // Changelog:
    //  2016-09-12 roland.tapken@rasch.de: Feld 'ambiente_type' hinzugefügt
    //             und den Hinweis ergänzt, dass auch Freitexteingaben möglich sind.
    //  2017-03-20 roland.tapken@rasch.de: Adapted for "eCollection 2.0"
    -->
    <!--
    // Information about the supplier of the data within this file.
    // Cardinality: 1
    -->
    <supplier>
        <!--
        // Name of supplier
        // Cardinality: 1
        -->
        <name>Example Wallpapers</name>

        <!-- 
        // Logo with alpha channel (for dark background). Height up to 80px.
        // Cardinality: 0..1
        -->
        <logo>https://example.com/resources/logo.png</logo>
    </supplier>

    <!-- 
    // List of collections. One <collection>...</collection> entry per collection. 
    // Cardinality: 1..n
    -->
    <collection>
        <!--
        // Name of the collection.
        // Cardinality: 1
        -->
        <name>Name of collection</name>

        <!--
        // Collection intro image (16:9, at least 1920x1080).
        // Default: The first room image of the collection will be used.
        //
        // Cardinality: 0..1
        -->
        <picture_url>https://example.com/resources/collection_123.png</picture_url>

        <!--
        // List of articles that are used within the rooms. Each article
        // must have an EAN code (or GTIN), an image in 1920x1080
        // and a description in at least one language.
        //
        // Cardinality: 1..n
        -->
        <article>
            <!--
            // Unique identifier of the article (should be either EAN or GTIN)
            // Cardinality: 1
            -->
            <ean>1234567800123</ean>

            <!-- 
            // Name of the article
            // Cardinality: 1
            -->
            <label>Titelbeschriftung</label>

            <!--
            // Article scan in 16:9 (at least 1920x1080px).
            // Cardinality: 1
            -->
            <picture_url>https://example.com/resources/01234536.jpg</picture_url>

            <!--
            // Preview image in ~1:1 (at least 160x16px), for product search.
            // Default: Use a reduced version of <picture_url>...</picture_url>
            // Cardinality: 0..1
            -->
            <picture_url_preview>https://example.com/resources/01234536.small.jpg</picture_url_preview>

            <!--
            // Pattern type from http://rds.rasch.de/wiki/services/ecollection/pattern/
            // Default: None (not available in product search)
            // Cardinality: 0..1
            -->
            <pattern>PLAIN</pattern>

            <!--
            // Style from http://rds.rasch.de/wiki/services/ecollection/style/
            // Alternative: Free text (only if no matching style is available, will not be translated)
            // Default: None (not available in product search)
            // Cardinality: 0..1
            -->
            < style>BASIC</style>

            <!--
            // Material type from http://rds.rasch.de/wiki/services/ecollection/material/
            // Alternative: Free text (only if no matching material is available, will not be translated)
            // Default: None (not available in product search)
            // Cardinality: 0..1
            -->
            <material>PAPER</material>

            <!--
            // Room types from http://rds.rasch.de/wiki/services/ecollection/rooms/
            // Alternative: Free text (only if no matching style is available, will not be translated)
            // Default: None (not available in product search)
            // Cardinality: 0..n
            -->
            <room>SLEEPING</room>

            <!--
            // Colouring from http://rds.rasch.de/wiki/services/ecollection/hue/
            // Default: None (not available in product search)
            // Repeat the pattern for each colouring
            // Cardinality: 0..n
            -->
            <colour>RED</colour>

            <!--
            // Article description in different languages. Can contain
            // HTML code. Newlines (0x10) will be converted into linewraps.
            // Cardinality: 1..n
            -->
            <description lang="de">Description</description>
        </article>

        <!--
        // Room images. Every room image references one or more articles by EAN or GTIN.
        // Cardinality: 1..n
        -->
        <room>
            <!--
            // Room image (16:9, at least 1920x1080px)
            // Cardinality: 1
            -->
            <picture_url>https://example.com/resources/01234536.jpg</picture_url>

            <!--
            // List of article identifiers.
            // Cardinality: 1..n
            -->
            <article>1234567800123</article>
        </room>
    </collection>
</ecollection>