GET
/api/v1/houses/{houseId}/buyer-links
operationId listBuyerLinks
- Bearer-token
- Kräver läsrätt i huset
Parametrar
| Namn | Var | Typ | Krävs |
|---|
houseId |
adressen |
integer |
ja |
Exempel
curl -X GET "https://husvo.app/api/v1/houses/1/buyer-links" \
-H "Authorization: Bearer $TOKEN"
Svar
200 Klart · BuyerLinkListResponse
{
"items": [
{
"id": 1,
"createdAt": "2026-11-13T08:00:00Z",
"validUntil": "2026-11-13T08:00:00Z",
"createdBy": "text",
"showHouseName": false,
"openCount": 1,
"lastOpenedAt": "2026-11-13T08:00:00Z",
"paperIds": [
1
]
}
]
}
Fel, som problem+json (felkoderna):
- 404Finns inte, eller inte för dig
POST
/api/v1/houses/{houseId}/buyer-links
operationId createBuyerLink
- Bearer-token
- Kräver redigeringsrätt i huset
- Skrivtaket gäller
Parametrar
| Namn | Var | Typ | Krävs |
|---|
houseId |
adressen |
integer |
ja |
Kropp application/json · BuyerLinkBody
| Fält | Typ | Krävs |
|---|
days |
integer |
nej |
showHouseName |
boolean |
nej |
paperIds |
integer[] |
nej |
{
"days": 1,
"showHouseName": false,
"paperIds": [
1
]
}
Exempel
curl -X POST "https://husvo.app/api/v1/houses/1/buyer-links" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"days":1,"showHouseName":false,"paperIds":[1]}'
Svar
201 Skapad · BuyerLinkCreatedDto
{
"id": 1,
"url": "https://exempel.se/",
"validUntil": "2026-11-13T08:00:00Z",
"showHouseName": false
}
Fel, som problem+json (felkoderna):
- 403Inte tillåtet
- 422Kontrollera uppgifterna
DELETE
/api/v1/houses/{houseId}/buyer-links/{buyerLinkId}
operationId revokeBuyerLink
- Bearer-token
- Kräver redigeringsrätt i huset
- Skrivtaket gäller
Parametrar
| Namn | Var | Typ | Krävs |
|---|
houseId |
adressen |
integer |
ja |
buyerLinkId |
adressen |
integer |
ja |
Exempel
curl -X DELETE "https://husvo.app/api/v1/houses/1/buyer-links/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