Disconnection summaries

Retrieve per-property summaries of partial and full disconnections.

Operations

Retrieve disconnection summary for multiple properties

Request

Retrieve disconnection summaries for all properties you previously managed, grouped by property.

A summary lists each connection type the property previously had with you but doesn't have now, with the time it was disconnected. When a connection type is reconnected, it's removed from the summary. Reactivating a connection doesn't clear the connection types that weren't reconnected.

A property can therefore have a disconnection summary while it still has an active connection with you. For example, if a property keeps the RESERVATIONS connection type but switches its PHOTOS connection type to a specialised provider, its summary shows the disconnection time of PHOTOS.

fully_disconnected shows whether the property currently has no active connection with you. Summaries only include disconnections on or after 1 October 2023, 00:00 UTC.

Results are paginated. To navigate between pages, use the meta.next_page and meta.prev_page URLs in the response.

Security

BearerAuth

Query

start_timestring, (date-time)

Only include properties with at least one disconnection on or after this date and time (UTC). For each matching property, all its disconnections are returned, including those outside the queried time range. Format: YYYY-MM-DDThh:mm:ssZ.

Example:start_time=2018-10-10T12:34:56Z

end_timestring, (date-time)

Only include properties with at least one disconnection before this date and time (UTC). For each matching property, all its disconnections are returned, including those outside the queried time range. Format: YYYY-MM-DDThh:mm:ssZ.

Example:end_time=2018-10-10T12:34:56Z

page_sizeinteger, (int32), [ 1 .. 100 ]

Maximum number of items to return per page.

Default:10

cursorstring

Opaque cursor for fetching the next or previous page. To paginate, use the full URL from meta.next_page or meta.prev_page directly rather than extracting the cursor value.

order_bystring

Sort order for results. Format: field_name asc or field_name desc. Supported field: last_disconnected_at.

Default:"last_disconnected_at asc"

disconnection_typestring

Only include properties that were partially disconnected (PARTIAL), fully disconnected (FULL), or either (ANY). Values are case-insensitive. Uppercase is the canonical form.

Default:"ANY"

Enum:"ANY""PARTIAL""FULL"

curl -i -X GET \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification/properties/-/disconnection-summaries?start_time=2018-10-10T12%3A34%3A56Z&end_time=2018-10-10T12%3A34%3A56Z&page_size=10&cursor=string&order_by=last_disconnected_at%20asc&disconnection_type=ANY' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful operation

Headers

X-RUIDstring, (uuid)

Unique request ID. Include this value when contacting support.

Bodyapplication/json

metaobject(PaginatedResponseMeta)

warningsArray of objects(ApiError)

errorsArray of objects(ApiError)

dataArray of objects(DisconnectionSummary)

Response

{
  "meta": {
    "prev_page": "https://supply-xml.booking.com/connections-api/properties/-/disconnection-summaries?page_size=2&order_by=last_disconnected_at+asc&cursor=AAAAAAAg3nEBAAAAAGVIycA",
    "next_page": "https://supply-xml.booking.com/connections-api/properties/-/disconnection-summaries?page_size=2&order_by=last_disconnected_at+asc&cursor=AAAAAABoy2UAAAAAAGVTSX8",
    "prev_count": 2,
    "next_count": 1,
    "ruid": "fee464e7-1b41-4834-b665-b2aeba62ba7d"
  },
  "warnings": [],
  "errors": [],
  "data": [
    { … },
    { … }
  ]
}