W3C Member Submission

Volkswagen Infotainment Web Interface service definition: viwi.service.medialibrary

W3C Member Submission

This version:
https://www.w3.org/submissions/2016/SUBM-viwi-service-medialibrary-20161213/
Latest published version:
https://www.w3.org/submissions/viwi-service-medialibrary/
Editor:
Dr. Patrick Bartsch, Volkswagen AG

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications can be found in the W3C technical reports index at https://www.w3.org/TR/.

This is required.

By publishing this document, W3C acknowledges that the Submitting Members have made a formal Submission request to W3C for discussion. Publication of this document by W3C indicates no endorsement of its content by W3C, nor that W3C has, is, or will be allocating any resources to the issues addressed by it. This document is not the product of a chartered W3C group, but is published as potential input to the W3C Process. A W3C Team Comment has been published in conjunction with this Member Submission. Publication of acknowledged Member Submissions at the W3C site is one of the benefits of W3C Membership. Please consult the requirements associated with Member Submissions of section 3.3 of the W3C Patent Policy. Please consult the complete list of acknowledged W3C Member Submissions.

Volkswagen Infotainment Web Interface

service definition: viwi.service.medialibrary

 

viwi

by Dr. Patrick Bartsch 2013-2016

 

version: v1.6.1-W3C

 

This repo holds all media library (tracks, albums, etc.) related resources

Table of contents

General information

version: 1.6.1-W3C

Repository:

Author

Dr. Patrick Bartsch <patrick.bartsch@volkswagen.de>

Resources

/medialibrary/sources/

This endpoint provides access to the media sources available in the media library.

mediaLibrarySourceObject

Properties
name description type format unit(s) value(s)
id identifier string uuid -
name source name string -
uri object uri string uri -
rootfolder the sources root folder, only set if medium is plugged in, undefined otherwise object /medialibrary/folders/folderObject

Resource level access (/medialibrary/sources/)

GET

Note: Use a http GET request on /medialibrary/sources/ to retrieve a list of available elements of type mediaLibrarySourceObject

Subscribe to /medialibrary/sources/ to receive updates for element creations or removals from the collection.

Request/response example
GET /medialibrary/sources/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6

=>

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/sources/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/medialibrary/sources/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/medialibrary/sources/:uuid)

GET

Note:

Use a http GET request on /medialibrary/sources/:uuid to retrieve a particular mediaLibrarySourceObject

Subscribe to /medialibrary/sources/:uuid to receive updates on element level changes.

Request/response example
GET /medialibrary/sources/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/sources/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

Events

The following events may be fired by client interaction or system side:

/medialibrary/tracks/

Provides a list of all tracks available in the system, might contain connected devices content as well.

trackObject

Properties

name description type format unit(s) value(s)
id identifier string uuid -
name Track title string -
uri object uri string uri -
image cover art string uri -
genres track genre array /medialibrary/genres/genreObject
folders actual folder the item resides in array /medialibrary/folders/folderObject
rating owner rating integer [-inf..inf]
albums albums containing this track array /medialibrary/albums/albumObject
artists track artists array /medialibrary/artists/artistObject
date release date string date-time -
disc disc of album integer [-inf..inf]
duration track duration integer s [-inf..inf]
source Source of the file object /medialibrary/sources/mediaLibrarySourceObject

Resource level access (/medialibrary/tracks/)

GET

Note: Use a http GET request on /medialibrary/tracks/ to retrieve a list of available elements of type trackObject

Subscribe to /medialibrary/tracks/ to receive updates for element creations or removals from the collection.

Request/response example
GET /medialibrary/tracks/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6

=>

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/tracks/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/medialibrary/tracks/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/medialibrary/tracks/:uuid)

GET

Note:

Use a http GET request on /medialibrary/tracks/:uuid to retrieve a particular trackObject

Subscribe to /medialibrary/tracks/:uuid to receive updates on element level changes.

Request/response example
GET /medialibrary/tracks/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/tracks/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

Events

The following events may be fired by client interaction or system side:

/medialibrary/albums/

Provides a list of all albums available in the system, might contain connected devices content as well.

albumObject

Properties

name description type format unit(s) value(s)
id Identifier string uuid -
name album title string -
uri object uri string uri -
genres album genre array /medialibrary/genres/genreObject
image album art string uri -
rating album rating integer [-inf..5]
artists album artist array /medialibrary/artists/artistObject
date release date string date-time -
duration total album duration integer sec [-inf..inf]
tracks album tracks array /medialibrary/tracks/trackObject

Resource level access (/medialibrary/albums/)

GET

Note: Use a http GET request on /medialibrary/albums/ to retrieve a list of available elements of type albumObject

Subscribe to /medialibrary/albums/ to receive updates for element creations or removals from the collection.

Request/response example
GET /medialibrary/albums/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6

=>

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/albums/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/medialibrary/albums/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/medialibrary/albums/:uuid)

GET

Note:

Use a http GET request on /medialibrary/albums/:uuid to retrieve a particular albumObject

Subscribe to /medialibrary/albums/:uuid to receive updates on element level changes.

Request/response example
GET /medialibrary/albums/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/albums/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

Events

The following events may be fired by client interaction or system side:

/medialibrary/artists/

Provides a list of all known artists, might contain connected devices content as well.

artistObject

Properties

name description type format unit(s) value(s)
id identifier string uuid -
name artist name string -
uri object uri string uri -
genres artist genre array /medialibrary/genres/genreObject
image artist art string uri -
rating owner rating integer [-inf..inf]
albums artist albums array /medialibrary/albums/albumObject
tracks artists tracks array /medialibrary/tracks/trackObject

Resource level access (/medialibrary/artists/)

GET

Note: Use a http GET request on /medialibrary/artists/ to retrieve a list of available elements of type artistObject

Subscribe to /medialibrary/artists/ to receive updates for element creations or removals from the collection.

Request/response example
GET /medialibrary/artists/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6

=>

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/artists/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/medialibrary/artists/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/medialibrary/artists/:uuid)

GET

Note:

Use a http GET request on /medialibrary/artists/:uuid to retrieve a particular artistObject

Subscribe to /medialibrary/artists/:uuid to receive updates on element level changes.

Request/response example
GET /medialibrary/artists/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/artists/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

Events

The following events may be fired by client interaction or system side:

/medialibrary/genres/

Provides an aggregated view over all known genres an the media related to it.

genreObject

Properties

name description type format unit(s) value(s)
id identifier string uuid -
name genre name string -
uri object uri string uri -
rating owner rating integer [-inf..inf]
tracks artists tracks array /medialibrary/tracks/trackObject

Resource level access (/medialibrary/genres/)

GET

Note: Use a http GET request on /medialibrary/genres/ to retrieve a list of available elements of type genreObject

Subscribe to /medialibrary/genres/ to receive updates for element creations or removals from the collection.

Request/response example
GET /medialibrary/genres/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6

=>

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/genres/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/medialibrary/genres/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/medialibrary/genres/:uuid)

GET

Note:

Use a http GET request on /medialibrary/genres/:uuid to retrieve a particular genreObject

Subscribe to /medialibrary/genres/:uuid to receive updates on element level changes.

Request/response example
GET /medialibrary/genres/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/genres/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

Events

This endpoint will not send any events. Therefor you can not register for them.

/medialibrary/playlists/

Provides a list of all playlists available in the system, might contain connected devices content as well.

playlistObject

Properties

name description type format unit(s) value(s)
id identifier string uuid -
name playlist name string -
uri object uri string uri -
genres playlist genre array /medialibrary/genres/genreObject
folders actual folder the item resides in object /medialibrary/folders/folderObject
image playlist art string uri -
rating owner rating integer [-inf..inf]
artists playlist artists array /medialibrary/artists/artistObject
date last modification string date-time -
duration total duration integer s [-inf..inf]
tracks playlist tracks array /medialibrary/tracks/trackObject

Resource level access (/medialibrary/playlists/)

POST

Note: Use a http POST request on /medialibrary/playlists/ to create a new element of type playlistObject

Subscribe to /medialibrary/playlists/ to receive updates for element creations or removals from the collection.

Request parameters

The following parameters can be used with the request and subscriptions:

name type format mandatory
name string yes
Request/response example
POST /medialibrary/playlists/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6


{
  "viwi": "rockz.."
}

=>

HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked
Location: /medialibrary/playlists/3901a278-ba17-44d6-9aef-f7ca67c04840


{
  "status": "ok"
}

GET

Note: Use a http GET request on /medialibrary/playlists/ to retrieve a list of available elements of type playlistObject

Subscribe to /medialibrary/playlists/ to receive updates for element creations or removals from the collection.

Request/response example
GET /medialibrary/playlists/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6

=>

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/playlists/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/medialibrary/playlists/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/medialibrary/playlists/:uuid)

POST

Note:

Use a http POST request on /medialibrary/playlists/:uuid to update a particular playlistObject

Subscribe to /medialibrary/playlists/:uuid to receive updates on element level changes.

Request parameters

The following parameters can be used with the request and subscriptions:

name type mandatory
tracks array no
rating integer no
image string no
Request/response example
POST /medialibrary/playlists/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6


{
  "viwi": "rockz.."
}
HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok"
}

GET

Note:

Use a http GET request on /medialibrary/playlists/:uuid to retrieve a particular playlistObject

Subscribe to /medialibrary/playlists/:uuid to receive updates on element level changes.

Request/response example
GET /medialibrary/playlists/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/playlists/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

DELETE

Note:

Use a http DELETE request on /medialibrary/playlists/:uuid to update a particular playlistObject

Subscribe to /medialibrary/playlists/:uuid to receive updates on element level changes.

Request/response example
DELETE /medialibrary/playlists/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok"
}

Events

This endpoint will not send any events. Therefor you can not register for them.

/medialibrary/folders/

Provides access to the media in folder layout, might contain contet of connected devices as well.

folderObject

Properties

name description type format unit(s) value(s)
id identifier string uuid -
name Folder name string -
uri object uri string uri -
tracks track files in folder array /medialibrary/tracks/trackObject
playlists playlist files in folder array /medialibrary/playlists/playlistObject
videos video files in folder array /medialibrary/videos/videoObject
pictures pictures files in folder array /medialibrary/pictures/pictureObject
folders folders in folder array /medialibrary/folders/folderObject
abspath absolute path to folder string -
parent parent folder object /medialibrary/folders/folderObject

Resource level access (/medialibrary/folders/)

GET

Note: Use a http GET request on /medialibrary/folders/ to retrieve a list of available elements of type folderObject

Subscribe to /medialibrary/folders/ to receive updates for element creations or removals from the collection.

Request/response example
GET /medialibrary/folders/ HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6

=>

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/folders/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/medialibrary/folders/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/medialibrary/folders/:uuid)

GET

Note:

Use a http GET request on /medialibrary/folders/:uuid to retrieve a particular folderObject

Subscribe to /medialibrary/folders/:uuid to receive updates on element level changes.

Request/response example
GET /medialibrary/folders/3901a278-ba17-44d6-9aef-f7ca67c04840 HTTP/1.1
Host: 127.0.0.1:9000
Connection: keep-alive
Accept: application/json
User-Agent: Chrome/34.0.1847.137 Safari/537.36
Accept-Encoding: gzip,deflate
Accept-Language: en-US,en;q=0.8,de;q=0.6
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json; charset=utf-8
ETag: "-32550834"
Content-Encoding: gzip
Date: Tue, 07 Apr 1980 00:00:00 GMT
Connection: keep-alive
Transfer-Encoding: chunked


{
  "status": "ok",
  "data": [
    {
      "id": "3901a278-ba17-44d6-9aef-f7ca67c04840",
      "name": "lorem ipsum",
      "uri": "/medialibrary/folders/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

Events

The following events may be fired by client interaction or system side: