Filmstore - API

An API to access an SQLite DB on a raspberry that manages my film rolls so i can find the photos i took.

API Documentation

Multiple endpoints are available.

GET /api/v1

Returns a JSON with 200

GET /api/v1/films

Returns a list of all Films (as in brands) Response:

{
  "status": 200,
  "message": "",
  "films": [
    {
      "id": 123,
      "name": "Ilford HP5+",
      "ISO": 400,
      "development_info": "",
      "type": 1,
      "format": 1
    }
  ]
}

GET /api/v1/films/{id}

Returns a single film (as in brand) Response:

{
  "status": 200,
  "message": "",
  "films": {
    "id": 123,
    "name": "Ilford HP5+",
    "ISO": 400,
    "development_info": "",
    "type": 1,
    "format": 1
  }
}

GET /api/v1/filmrolls

Returns all the film rolls stored. Response:

{
  "status": 200,
  "message": "",
  "filmrolls": [
    {
      "film": {
        "id": 123,
        "name": "Ilford HP5+",
        "ISO": 400,
        "development_info": "",
        "type": 1,
        "format": 1
      },
      "pictures": [123, 124, 125],
      "status": 3,
      "camera": "Olympus OM2n",
      "identifier": "Archival Identifier",
      "db_id": 123
    }
  ]
}

GET /api/v1/filmrolls/{id}

Returns a single film roll Response:

{
  "status": 200,
  "message": "",
  "id": 123,
  "film": {
    "id": 123,
    "name": "Ilford HP5+",
    "ISO": 400,
    "development_info": "",
    "type": 1,
    "format": 1
  },
  "pictures": [123, 124, 125],
  "filmroll_status": 3,
  "camera": "Olympus OM2n",
  "identifier": "Archival Identifier"
}

GET /api/v1/pictures/{id}

Returns a single image details with the image encoded in Base64 in JPEG format. Response:

to be defined

POST /api/v1/films

Adds a new film brand. Request:

{
  "name": "Lomography Berlin Kino",
  "iso": 400,
  "development_info": "ISO 100 pull gives a thick grain",
  "type": 1,
  "format": 1
}

Response:

{
  "status": 200,
  "message": ""
}

POST /api/v1/films/{id}

Alters a film stock with the given data. Request:

{
  "name": "Lomography Berlin Kino",
  "iso": 400,
  "development_info": "ISO 100 pull gives a thick grain",
  "type": 1,
  "format": 1 
}

Response:

{
  "status": 200,
  "message": "Film roll {id} has been updated successfully"
}

POST /api/v1/pictures

Adds a new image with details. HTTP Form Request:

• file: contains image file (currently only image/jpeg is supported)
• req: contains json formatted as follows Request:

{
  "description": "",
  "location": "",
  "aperture": "1.4",
  "shutter_speed": "1/1000",
  "posted": false,
  "printed": false
}

Response:

{
  "status": 200,
  "message": "",
  "picture_id": 123
}

POST /api/v1/filmrolls

Adds a new film roll. Request:

{
  "camera": "Olympus Pen EE",
  "film": 123,
  "identifier": "Archival identifier",
  "pictures": [123, 124, 125],
  "status": 5
}

Response:

{
  "status": 200,
  "message": "",
  "filmroll_id": 123
}

DELETE /api/v1/films/{id}

Deletes permanently the specified film ID. Do note that any film roll referencing the stock to delete will also be permanently deleted with no way of recovering them. This means that any picture in those film rolls will also be removed. Response:

{
  "status": 200,
  "message": "Film stock deleted successfully",
  "deleted_item": {
    "name": "Lomography Berlin Kino",
    "iso": 400,
    "development_info": "ISO 100 pull gives a thick grain",
    "type": 1,
    "format": 1 
  }
}

Enumeration definitions

A value of 0 is always to be considered undefined.

Film Format (format)

1. 35mm
2. 120
3. 127
4. 110
5. Sheet film

Film Type (type)

1. Black and White Panchromatic
2. Black and White Orthochromatic
3. Color
4. Infrared

Development Status (filmroll_status)

1. In camera
2. To be developed
3. Developed
4. Scanned
5. Archived