W3C Member Submission

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

W3C Member Submission

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

Copyright © 2016 . This document is available under the W3C Document License. See the W3C Intellectual Rights Notice and Legal Disclaimers for additional information.

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.cdn

 

viwi

by Dr. Patrick Bartsch 2013-2016

 

version: v1.5.3-W3C

 

Content delivery network service for viwi

Table of contents

General information

version: 1.5.3-W3C

Repository:

Author

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

Resources

/cdn/images/

Retrieve binary image data. The server will scale content down - not up - on request. If not othewise requested, it will deliver the closest match (default).

imageObject

Properties

name description type format unit(s) value(s)

Resource level access (/cdn/images/)

GET

Note: Use a http GET request on /cdn/images/ to retrieve a list of available elements of type imageObject

Subscribe to /cdn/images/ 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
w integer no
h integer no
scale boolean no
Request/response example
GET /cdn/images/ 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": "/cdn/images/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/cdn/images/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/cdn/images/:uuid)

GET

Note:

Use a http GET request on /cdn/images/:uuid to retrieve a particular imageObject

Subscribe to /cdn/images/:uuid to receive updates on element level changes.

Request parameters

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

name type mandatory
w integer no
h integer no
scale boolean no
Request/response example
GET /cdn/images/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": "/cdn/images/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

PUT

Note:

Use a http PUT request on /cdn/images/:uuid to create a custom imageObject

Subscribe to /cdn/images/:uuid to receive updates on element level changes.

Request/response example
PUT /cdn/images/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
Location: /cdn/images/3901a278-ba17-44d6-9aef-f7ca67c04840

{
  "status": "ok"
}

DELETE

Note:

Use a http DELETE request on /cdn/images/:uuid to update a particular imageObject

Subscribe to /cdn/images/:uuid to receive updates on element level changes.

Request/response example
DELETE /cdn/images/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.

/cdn/certificates/

Retrieve binary certificates.

certificateObject

Properties

name description type format unit(s) value(s)

Resource level access (/cdn/certificates/)

GET

Note: Use a http GET request on /cdn/certificates/ to retrieve a list of available elements of type certificateObject

Subscribe to /cdn/certificates/ to receive updates for element creations or removals from the collection.

Request/response example
GET /cdn/certificates/ 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": "/cdn/certificates/3901a278-ba17-44d6-9aef-f7ca67c04840"
    },
    {
      "id": "8901870-b526-11e3-a5e2-0800200c9a66",
      "name": "dolor sit",
      "uri": "/cdn/certificates/8901870-b526-11e3-a5e2-0800200c9a66"
    }
  ]
}

Element level access (/cdn/certificates/:uuid)

GET

Note:

Use a http GET request on /cdn/certificates/:uuid to retrieve a particular certificateObject

Subscribe to /cdn/certificates/:uuid to receive updates on element level changes.

Request/response example
GET /cdn/certificates/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": "/cdn/certificates/3901a278-ba17-44d6-9aef-f7ca67c04840"
    }
  ]
}

Events

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