Husvo

API-referens

Pärmen

Husets papper: köpehandlingar, ritningar, besiktning, försäkring och annat.

Husets papper per sort i webbens ordning, med giltighet för dem som har ett slutdatum

GET /api/v1/houses/{houseId}/papers

operationId listPapers

  • Bearer-token
  • Kräver att du hör till hushållet

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

curl -X GET "https://husvo.app/api/v1/houses/1/papers" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · PaperListResponse
{
  "items": [
    {
      "kind": "text",
      "label": "text",
      "items": [
        {
          "id": 1,
          "kind": "text",
          "title": "text",
          "date": "2026-11-13",
          "validUntil": "2026-11-13",
          "validity": "text",
          "fileName": "text",
          "contentType": "text",
          "sizeBytes": 1,
          "uploadedBy": "text",
          "url": "https://exempel.se/"
        }
      ]
    }
  ]
}

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig

Ladda upp ett papper (multipart: file, kind, title, date, validUntil). Pdf eller bild, högst 25 MB

POST /api/v1/houses/{houseId}/papers

operationId uploadPaper

  • Bearer-token
  • Kräver redigeringsrätt i huset
  • Skrivtaket gäller
  • Tar Idempotency-Key

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Kropp multipart/form-data · PaperUploadForm

FältTypKrävs
file fil ja
kind string ja
title string nej
date datum ja
validUntil datum nej

Filen skickas som den är, med sin egen innehållstyp.

Exempel

curl -X POST "https://husvo.app/api/v1/houses/1/papers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "file=@papper.pdf" -F "kind=other"

Svar

201 Skapad · PaperDto
{
  "id": 1,
  "kind": "text",
  "title": "text",
  "date": "2026-11-13",
  "validUntil": "2026-11-13",
  "validity": "text",
  "fileName": "text",
  "contentType": "text",
  "sizeBytes": 1,
  "uploadedBy": "text",
  "url": "https://exempel.se/"
}

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig
  • 413För stort
  • 422Kontrollera uppgifterna

Papperets fil, pdf eller bild. Stöder Range

GET /api/v1/houses/{houseId}/papers/{paperId}/content

operationId getPaperContent

  • Bearer-token
  • Kräver att du hör till hushållet

Parametrar

NamnVarTypKrävs
houseId adressen integer ja
paperId adressen integer ja

Exempel

curl -X GET "https://husvo.app/api/v1/houses/1/papers/1/content" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · application/pdf, image/jpeg, image/png, image/webp

Svaret är filen själv.

304 Oförändrad sedan förra hämtningen

Inget innehåll.

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig

Ändra sort, titel, datum eller slutdatum. Filen ligger kvar

PATCH /api/v1/houses/{houseId}/papers/{paperId}

operationId updatePaper

  • Bearer-token
  • Kräver redigeringsrätt i huset
  • Skrivtaket gäller

Parametrar

NamnVarTypKrävs
houseId adressen integer ja
paperId adressen integer ja

Kropp application/json · PaperPatchBody

FältTypKrävs
kind string nej
title string nej
date datum nej
validUntil datum nej
clearValidUntil boolean nej
{
  "kind": "text",
  "title": "text",
  "date": "2026-11-13",
  "validUntil": "2026-11-13",
  "clearValidUntil": false
}

Exempel

curl -X PATCH "https://husvo.app/api/v1/houses/1/papers/1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind":"text","title":"text","date":"2026-11-13","validUntil":"2026-11-13","clearValidUntil":false}'

Svar

200 Klart · PaperDto
{
  "id": 1,
  "kind": "text",
  "title": "text",
  "date": "2026-11-13",
  "validUntil": "2026-11-13",
  "validity": "text",
  "fileName": "text",
  "contentType": "text",
  "sizeBytes": 1,
  "uploadedBy": "text",
  "url": "https://exempel.se/"
}

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig
  • 422Kontrollera uppgifterna

Ta bort papperet, både raden och filen

DELETE /api/v1/houses/{houseId}/papers/{paperId}

operationId deletePaper

  • Bearer-token
  • Kräver redigeringsrätt i huset
  • Skrivtaket gäller

Parametrar

NamnVarTypKrävs
houseId adressen integer ja
paperId adressen integer ja

Exempel

curl -X DELETE "https://husvo.app/api/v1/houses/1/papers/1" \
  -H "Authorization: Bearer $TOKEN"

Svar

204 Klart, inget innehåll

Inget innehåll.

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 404Finns inte, eller inte för dig
Sidan hakade upp sig.Ladda om🗙