Module Fcr (v1)#

REST Requests:#

GET /api/v1/fcr/records
DELETE /api/v1/fcr/records/(name)
GET (url)

Websockets:#

Websocket endpoint: GET /api/v1/fcr/notifications

Websocket Events:

fcr_update

Module Fcr REST API (v1)#

GET /api/v1/fcr/records#

get record list

Status Codes:

200 OK – the record list – JSON Schema: array(record)
500 Internal Server Error – if there is a server internal error

Example:

Get the record list

GET /api/v1/fcr/records

[
  {
    "index": 21,
    "name": "stereo/fcr-1.jpeg",
    "date": "19700101T000000+0000",
    "size": 9989501,
    "url": "/data/fcr/stereo/fcr-1.jpeg"
  },
  {
    "index": 22,
    "name": "stereo_pair2/fcr-1.jpeg",
    "date": "19700101T000000+0000",
    "size": 3511604,
    "url": "/data/fcr/stereo_pair2/fcr-1.jpeg"
  },
  {
    "index": 23,
    "name": "stereo_pair2/fcr-2.jpeg",
    "date": "19700101T000000+0000",
    "size": 5075792,
    "url": "/data/fcr/stereo_pair2/fcr-2.jpeg"
  }
]

DELETE /api/v1/fcr/records/(name)#

delete a record

Parameters:

name (string) – the name of the record

Status Codes:

200 OK – no error
404 Not Found – if the requested record does not exist
500 Internal Server Error – if there is a server internal error

GET (url)#

download a record

Parameters:

url (string) – the relative url of the record (as returned in the record list)

Status Codes:

200 OK – content of the record (in response body) – JSON Schema: array(byte)
404 Not Found – if the requested record does not exist
500 Internal Server Error – if there is a server internal error

Module Fcr Websocket events (v1)#

Endpoint:

GET /api/v1/fcr/notifications#

Request Headers:

Connection – Upgrade
Upgrade – websocket

Events:

fcr_update

Module Fcr JSON Schema (v1)#

fcr_update#

type	object
properties
name	string

record#

type	object
properties
index	integer
name	string
date	string
size	integer
url	string