Home

Documentation

TFW Client-API

The Client-API is a REST compliant interface created and owned by traum-ferienwohnungen.

https://clientapi.traum-ferienwohnungen.de/apigility/documentation

theDisco/traum PHP Client

Traum is a PHP Client for TFW Client-API.

Roadmap

Occupancy

Endpoint	Implemented
GET /listing/:listing_id/occupancy	🚫
POST /listing/:listing_id/occupancy	🚫
PATCH /listing/:listing_id/occupancy	🚫
GET /listing/:listing_id/occupancy[/:occupancy_id]	🚫
PATCH /listing/:listing_id/occupancy[/:occupancy_id]	🚫
PUT /listing/:listing_id/occupancy[/:occupancy_id]	🚫

PriceTable

Endpoint	Implemented
GET /listing/:listing_id/price-table	✅
POST /listing/:listing_id/price-table	✅
DELETE /listing/:listing_id/price-table	✅
PATCH /listing/:listing_id/price-table	✅
GET /listing/:listing_id/price-table[/:price_table_id]	🚫
PATCH /listing/:listing_id/price-table[/:price_table_id]	🚫
PUT /listing/:listing_id/price-table[/:price_table_id]	🚫

PaymentOption

Endpoint	Implemented
GET /payment-option[/:listing_id]	✅
PATCH /payment-option[/:listing_id]	✅

Picture

Endpoint	Implemented
GET /listing/:listing_id/picture	✅
POST /listing/:listing_id/picture	✅
DELETE /listing/:listing_id/picture	✅
GET /listing/:listing_id/picture[/:picture_id]	🚫
PATCH /listing/:listing_id/picture[/:picture_id]	🚫
DELETE /listing/:listing_id/picture[/:picture_id]	🚫

PictureTitle

Endpoint	Implemented
GET /listing/:listing_id/picture/:picture_id/picture-title	✅
GET /listing/:listing_id/picture/:picture_id/picture-title[/:picture_title_id]	✅
PATCH /listing/:listing_id/picture/:picture_id/picture-title[/:picture_title_id]	✅

AdditionalCharge

Endpoint	Implemented
GET /listing/:listing_id/additional-charge	✅
POST /listing/:listing_id/additional-charge	✅
DELETE /listing/:listing_id/additional-charge	✅
GET /listing/:listing_id/additional-charge[/:additional_charge_id]	🚫
PATCH /listing/:listing_id/additional-charge[/:additional_charge_id]	🚫
DELETE /listing/:listing_id/additional-charge[/:additional_charge_id]	🚫

Arrival

Endpoint	Implemented
GET /listing/:listing_id/arrival	✅
POST /listing/:listing_id/arrival	✅
DELETE /listing/:listing_id/arrival	✅
GET /listing/:listing_id/arrival[/:arrival_id]	✅
DELETE /listing/:listing_id/arrival[/:arrival_id]	✅

Room

Endpoint	Implemented
GET /listing/:listing_id/room	✅
POST /listing/:listing_id/room	✅
DELETE /listing/:listing_id/room	✅
GET /listing/:listing_id/room[/:room_id]	✅
PATCH /listing/:listing_id/room[/:room_id]	✅
DELETE /listing/:listing_id/room[/:room_id]	✅