Manualerna

Manualer kopplade till prylar, och sökning i deras text.

GET/api/v1/houses/{houseId}/manuals Husets manualer, valfritt för en pryl (?applianceId=)
GET/api/v1/houses/{houseId}/manuals/search Fritextsökning i manualerna. Bäst träff först, med utdrag där träffen är markerad
GET/api/v1/houses/{houseId}/manuals/{manualId}/content Manualen som pdf. Stöder Range

Husets manualer, valfritt för en pryl (?applianceId=)

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

operationId listManuals

Bearer-token
Kräver läsrätt i huset

Parametrar

Namn	Var	Typ	Krävs
`houseId`	adressen	integer	ja
`applianceId`	frågesträngen	integer	nej

Exempel

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

Svar

200 Klart · ManualListResponse

{
  "items": [
    {
      "id": 1,
      "applianceId": 1,
      "applianceName": "text",
      "name": "text",
      "pages": 1,
      "sizeBytes": 1,
      "sourceUrl": "https://exempel.se/",
      "addedAt": "2026-11-13T08:00:00Z"
    }
  ]
}

Fel, som problem+json (felkoderna):

404Finns inte, eller inte för dig

Fritextsökning i manualerna. Bäst träff först, med utdrag där träffen är markerad

GET /api/v1/houses/{houseId}/manuals/search

operationId searchManuals

Bearer-token
Kräver läsrätt i huset

Parametrar

Namn	Var	Typ	Krävs
`houseId`	adressen	integer	ja
`q`	frågesträngen	string	nej
`applianceId`	frågesträngen	integer	nej

Exempel

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

Svar

200 Klart · ManualSearchResponse

{
  "items": [
    {
      "manualId": 1,
      "applianceId": 1,
      "applianceName": "text",
      "manualName": "text",
      "page": 1,
      "snippet": [
        {
          "text": "text",
          "hit": false
        }
      ]
    }
  ]
}

Fel, som problem+json (felkoderna):

404Finns inte, eller inte för dig
422Kontrollera uppgifterna

Manualen som pdf. Stöder Range

GET /api/v1/houses/{houseId}/manuals/{manualId}/content

operationId getManualContent

Bearer-token
Kräver läsrätt i huset

Parametrar

Namn	Var	Typ	Krävs
`houseId`	adressen	integer	ja
`manualId`	adressen	integer	ja

Exempel

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

Svar

200 Klart · application/pdf

Svaret är filen själv.

Fel, som problem+json (felkoderna):

404Finns inte, eller inte för dig