Rentals Contents Overrides

Rental content overrides endpoint was made so that different channels could have different length validations for our fields like headline, summary, description. By using those objects clients applications can use full available length at each channel.

  1. List rentals contents overrides
  2. Get a single rentals content override
  3. Create a new rentals content override
  4. Update a rentals content override
  5. Destroy a rentals content override

Parameters

Name Type Read/Write Description
id Integer Read Rentals Contents Override’s id.
description Object Read Description override for related application, list of locales described in enums section.
headline Object Read Headline override for related application, list of locales described in enums section.
summary Object Read Summary override for related application, list of locales described in enums section.
created_at Time Read Rentals Contents Override’s create time.
updated_at Time Read Rentals Contents Override’s update time.
Name Type Read/Write Description
id Integer Read Rentals Contents Override’s id.
application_id Integer Write Application id related to the Rentals Contents Override.
rental_id Integer Write Rental id related to the Rentals Contents Override.
description Object Read/Write Description override for related application, list of locales described in enums section.
headline Object Read/Write Headline override for related application, list of locales described in enums section.
summary Object Read/Write Summary override for related application, list of locales described in enums section.
created_at Time Read Rentals Contents Override’s create time.
updated_at Time Read Rentals Contents Override’s update time.

List rentals contents overrides

List all rentals contents overrides for a given account(s).

GET /rentals_contents_overrides

Response

{
  "links": {
    "rentals_contents_overrides.application": "https://www.bookingsync.com/api/v3/applications/{rentals_contents_overrides.application}",
    "rentals_contents_overrides.rental": "https://www.bookingsync.com/api/v3/rentals/{rentals_contents_overrides.rental}"
  },
  "rentals_contents_overrides": [
    {
      "id": 3,
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "meta": {
  }
}

Get a single rentals content override

Returns a single rentals content override identified by ID.

GET /rentals_contents_overrides/:rentals_content_override_id

Response

{
  "links": {
    "rentals_contents_overrides.application": "https://www.bookingsync.com/api/v3/applications/{rentals_contents_overrides.application}",
    "rentals_contents_overrides.rental": "https://www.bookingsync.com/api/v3/rentals/{rentals_contents_overrides.rental}"
  },
  "rentals_contents_overrides": [
    {
      "id": 3,
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "meta": {
  }
}

Create a new rentals content override

Creates a rentals content override for given rental.

POST /rentals_contents_overrides

Example JSON request

{
  "rentals_contents_overrides": [
    {
      "application_id": 1,
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "rental_id": 2,
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      }
    }
  ]
}

Response

{
  "links": {
    "rentals_contents_overrides.application": "https://www.bookingsync.com/api/v3/applications/{rentals_contents_overrides.application}",
    "rentals_contents_overrides.rental": "https://www.bookingsync.com/api/v3/rentals/{rentals_contents_overrides.rental}"
  },
  "rentals_contents_overrides": [
    {
      "id": 3,
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "meta": {
  }
}

Update a rentals content override

Returns an updated rentals content override identified by ID.

PUT /rentals_contents_overrides/:rentals_content_override_id

Example JSON request

{
  "rentals_contents_overrides": [
    {
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      }
    }
  ]
}

Response

{
  "links": {
    "rentals_contents_overrides.application": "https://www.bookingsync.com/api/v3/applications/{rentals_contents_overrides.application}",
    "rentals_contents_overrides.rental": "https://www.bookingsync.com/api/v3/rentals/{rentals_contents_overrides.rental}"
  },
  "rentals_contents_overrides": [
    {
      "id": 3,
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "links": {
        "application": 1,
        "rental": 2
      }
    }
  ],
  "meta": {
  }
}

Destroy a rentals content override

Required OAuth scope: :rentals_write

Returns empty response with ‘204 No Content’ status code on success.

DELETE /rentals_contents_overrides/:rentals_content_override_id