Vat

The Vat service allows you to modify and retrieve VAT information. The resource will be automatically generated for every new customer. Because every customer has only one VAT resource it is not possible to send DELETE/POST requests, also there are no collection methods. You can only PATCH and GET the resource entity with the customer_id as the service locator.

GET /vat[/:customer_id]

The Vat GET Entity allows the retrieving of the VAT information by the customer_id.

Fields

Field Type Description Required
enable_vat Expected data type: boolean | Description: If 'true' the price will be vat inclusive. The default is 'false'. YES

Request

Headers

Header Value
Accept
application/vnd.customer.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.customer.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/vat[/:customer_id]"
       }
   }
   "enable_vat": "Expected data type: boolean | Description: If 'true' the price will be vat inclusive. The default is 'false'."
}

PATCH /vat[/:customer_id]

The Vat PATCH Entity allows the modfication if the VAT should be inclusive oder exclusive

Fields

Field Type Description Required
enable_vat Expected data type: boolean | Description: If 'true' the price will be vat inclusive. The default is 'false'. YES

Request

Headers

Header Value
Accept
application/vnd.customer.v1+json
application/hal+json
application/json
Content-Type
application/vnd.customer.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "enable_vat": "Expected data type: boolean | Description: If 'true' the price will be vat inclusive. The default is 'false'."
}

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.customer.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/vat[/:customer_id]"
       }
   }
   "enable_vat": "Expected data type: boolean | Description: If 'true' the price will be vat inclusive. The default is 'false'."
}

Listing

The Listing service allows you to create new listings from scratch. In order to add more data to your new listing take a look at the Listing API. It is also possible to retrieve all listing ids for a customer and modify the basic information like the object type. But the modification of the object type is only possible in offline listings and in general not possible in the PATCH collection method. Also it is currently not allowed to delete listings via the API. If you need to deactivate or delete a listing please contact your sales/support team.

GET /customer/:customer_id/listing

The Listing GET Collection allows the retrieving of all listings which belong to customer.

Fields

Field Type Description Required
object_type_id Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage YES
email_type_id Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text NO

Request

Headers

Header Value
Accept
application/vnd.customer.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.customer.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/customer/:customer_id/listing"
       },
       "first": {
           "href": "/customer/:customer_id/listing?page={page}"
       },
       "prev": {
           "href": "/customer/:customer_id/listing?page={page}"
       },
       "next": {
           "href": "/customer/:customer_id/listing?page={page}"
       },
       "last": {
           "href": "/customer/:customer_id/listing?page={page}"
       }
   }
   "_embedded": {
       "listing": [
           {
               "_links": {
                   "self": {
                       "href": "/customer/:customer_id/listing[/:listing_id]"
                   }
               }
              "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
              "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
           }
       ]
   }
}

POST /customer/:customer_id/listing

The Listing POST Collection allows the creation of new listings for a customer.

Fields

Field Type Description Required
object_type_id Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage YES
email_type_id Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text NO

Request

Headers

Header Value
Accept
application/vnd.customer.v1+json
application/hal+json
application/json
Content-Type
application/vnd.customer.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
   "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
}

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.customer.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/customer/:customer_id/listing[/:listing_id]"
       }
   }
   "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
   "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
}

PATCH /customer/:customer_id/listing

The Listing PATCH Collection allows the modification of existing listings. It is not allowed to PATCH the object_type_id in collections.

Fields

Field Type Description Required
object_type_id Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage YES
email_type_id Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text NO

Request

Headers

Header Value
Accept
application/vnd.customer.v1+json
application/hal+json
application/json
Content-Type
application/vnd.customer.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
   "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
}

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.customer.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/customer/:customer_id/listing"
       },
       "first": {
           "href": "/customer/:customer_id/listing?page={page}"
       },
       "prev": {
           "href": "/customer/:customer_id/listing?page={page}"
       },
       "next": {
           "href": "/customer/:customer_id/listing?page={page}"
       },
       "last": {
           "href": "/customer/:customer_id/listing?page={page}"
       }
   }
   "_embedded": {
       "listing": [
           {
               "_links": {
                   "self": {
                       "href": "/customer/:customer_id/listing[/:listing_id]"
                   }
               }
              "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
              "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
           }
       ]
   }
}

GET /customer/:customer_id/listing[/:listing_id]

The Listing GET Entity allows the retrieving of the basic listing information by the listing_id.

Fields

Field Type Description Required
object_type_id Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage YES
email_type_id Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text NO

Request

Headers

Header Value
Accept
application/vnd.customer.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.customer.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/customer/:customer_id/listing[/:listing_id]"
       }
   }
   "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
   "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
}

PATCH /customer/:customer_id/listing[/:listing_id]

The Listing PATCH Entity allows the modfication of the basic listing data by the listing_id. It is not allowed to PATCH the object_type_id in online listings.

Fields

Field Type Description Required
object_type_id Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage YES
email_type_id Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text NO

Request

Headers

Header Value
Accept
application/vnd.customer.v1+json
application/hal+json
application/json
Content-Type
application/vnd.customer.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
   "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
}

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.customer.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/customer/:customer_id/listing[/:listing_id]"
       }
   }
   "object_type_id": "Expected data type: integer | Description: The property type | Allowed values: 2 => apartment, 3 => farmhouse, 4 => bio farm, 5 => bungalow, 9 => holiday house, 12 => holiday apartment, 14 => holiday room, 15 => finca, 21 => cottage, 23 => pension, 25 => villa, 28 => trailer, 30 => house boat, 31 => bed and breakfast, 32 => chalet, 33 => castle, 35 => cave dwelling, 38 => ski lodge, 39 => residence, 40 => alpine hut, 41 => sailing ship, 42 => guest room, 43 => terraced house, 44 => holiday cottage",
   "email_type_id": "Expected data type: integer | Description: The type of the emails you receive by Traum Ferienwohnungen | Allowed values: 1 => html + text, 2 => text"
}