{"items":[{"type":"link","label":"Connections API","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification","content":{"contentType":"overview","meta":{"name":"Connections API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"connections-api-specification.json","url":"/_bundle/connectivity/docs/openapispecs/connections-api/connections-api-specification.json?download"},{"kind":"download","label":"connections-api-specification.yaml","url":"/_bundle/connectivity/docs/openapispecs/connections-api/connections-api-specification.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://connect.booking.com","url":"https://connect.booking.com"},{"kind":"email","title":"Connectivity Team","email":"connectivity@booking.com","label":"connectivity@booking.com","withCopyButton":true,"copyContent":"connectivity@booking.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Copyright Booking.com. All rights reserved.","url":"https://www.booking.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Connections API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connections API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows connectivity providers to manage their connections with properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is an alternative to managing connections manually in the Provider Portal or relying on the emails Booking.com sends"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about new connection requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For providers, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"“managing connections”"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means deciding what to do with connection requests made"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by properties (accepting or rejecting them), deactivating connections, and retrieving updates about"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connections. This helps providers keep their own records up to date and limit errors when using other APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API differs from most Connectivity APIs."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Most Connectivity APIs allow providers to perform actions on behalf"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of properties, such as managing availability or retrieving reservations. In contrast, Connections API is meant to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used by providers for their own purposes: to manage how they themselves are connected to properties. In other words,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"most APIs support actions otherwise available to properties in the Extranet, while Connections API supports actions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available to providers in the Provider Portal."},"children":[]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/connections-api/connections-api-specification"},{"nodeType":"external-docs","url":"https://connect.booking.com/","description":"Find out more about Connectivity APIs"}],"sectionId":"/connectivity/docs/openapispecs/connections-api/connections-api-specification"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/connections"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connections"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the context of this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A “"},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"” is an abstraction of all "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between a provider and a property within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking.com Connectivity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By that definition, there cannot be multiple connections between one provider and one property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A connection is the basis for accessing Connectivity APIs on behalf of the property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One connection consists of one or more distinct connection types. The connection types indirectly specify what"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actions the provider is permitted to perform on the property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Pending) connection "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are distinct from (active) connections. A connection request is not yet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a connection, but it can become one if the provider approves it. A connection request is an abstraction of all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between a provider and a property within Booking.com Connectivity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A provider and a property cannot have both an active connection and a pending request at the same time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Therefore, the “connection state” between any given provider and property is either a connection, a request, or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"neither, but never a mix of them."},"children":[]}]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/connections"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/selected-user-scenarios"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selected user scenarios"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are examples of what providers can do with this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing recent connection requests to review them and approve or reject them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking whether a specific property’s request is still pending, for example, after taking manual actions in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provider’s interface and just before accepting it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking whether a specific property (one known to the provider by its Booking.com property ID and willing to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connect with them) has already requested a connection, that is, has a pending request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing recent connection requests to check whether a property known by name, but not by Booking.com property ID,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has already requested a connection."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieving a specific property’s request to verify that it is correct, for example, the requested connection types."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing all pending connection requests to clean up old or missed requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing recently disconnected properties to update their status in the provider’s database, or to follow up with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"properties about unexpected disconnections."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing recent partial disconnections to stop using APIs that are no longer available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing the properties that are missing a certain connection type or permission, so that the provider can request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional connection types from them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieving the details of the connection with an already-connected property to check whether a request for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional connection types succeeded."},"children":[]}]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/selected-user-scenarios"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-resources"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API resources"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From the provider’s perspective, there are three distinct resource types related to connections:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending connection requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active connections"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disconnections"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A provider’s "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active connections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are uniquely identified by the Booking.com property ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disconnection data is grouped into per-property summaries, a convenient way to think about and retrieve it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a result, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disconnection summaries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are also uniquely identified by the property ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, a lightweight "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource lets you check the connection status of a property."},"children":[]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/api-resources"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/related-apis"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related APIs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may need more information before accepting a connection request. For example, details of the commission or tax"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setup can be relevant for proper mapping. To avoid redundancy with other APIs, Connections API does not include this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information. For commission details, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GetCommissionOverride"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Tax data is included in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTA_HotelDescriptiveInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/related-apis"}]}]}},{"type":"link","label":"Connections","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/connections","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/connections","content":null},{"type":"link","label":"Selected user scenarios","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/selected-user-scenarios","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/selected-user-scenarios","content":null},{"type":"link","label":"API resources","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/api-resources","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/api-resources","content":null},{"type":"link","label":"Related APIs","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/related-apis","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/section/related-apis","content":null},{"type":"separator","label":"API Endpoints","content":null},{"type":"group","label":"Connections","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections","items":[{"label":"Retrieve a single active connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections/getactiveconnection","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections/getactiveconnection","metadata":{"seo":{"title":"Retrieve a single active connection","description":"Retrieve details about the active connection with a property."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActiveConnection","name":"Retrieve a single active connection","isWebhook":false,"pointer":"/paths/~1properties~1{propertyId}~1connection/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a single active connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve details about the active connection with a property."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This endpoint only checks for active connections. If no active connection is found, the endpoint returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. This happens both when the property is not connected to you at all and when it has a pending connection request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"propertyId","in":"path","schemaId":"schema_0","description":"The Booking.com property ID.","required":true}],"pointer":"/paths/~1properties~1{propertyId}~1connection/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/{propertyId}/connection","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[{"name":"propertyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/properties/{propertyId}/connection","href":"connections/getactiveconnection","openApiOperationId":"getActiveConnection","summary":"Retrieve a single active connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection found","paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection not found"]}},"schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection found","paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection not found"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/400/content/application~1json/examples/Invalid propertyId"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/400/content/application~1json/examples/Invalid propertyId"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1{propertyId}~1connection/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection found","paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection found","paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection not found"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/400/content/application~1json/examples/Invalid propertyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/400/content/application~1json/examples/Invalid propertyId"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/{propertyId}/connection"},{"label":"Deactivate an active connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections/deactivate","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections/deactivate","metadata":{"seo":{"title":"Deactivate an active connection","description":"Deactivate an active connection with a property. On successful deactivation, the endpoint returns a 200 OK response without a data field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivate","name":"Deactivate an active connection","isWebhook":false,"pointer":"/paths/~1properties~1{propertyId}~1connection/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an active connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate an active connection with a property. On successful deactivation, the endpoint returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only deactivate an active connection. If the property has a pending connection request instead, the endpoint returns an error. To decline a pending request, use the reject endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"propertyId","in":"path","schemaId":"schema_0","description":"The Booking.com property ID.","required":true}],"pointer":"/paths/~1properties~1{propertyId}~1connection/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/properties/{propertyId}/connection","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[{"name":"propertyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/properties/{propertyId}/connection","href":"connections/deactivate","openApiOperationId":"deactivate","summary":"Deactivate an active connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/200/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Request still pending","paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Invalid propertyId"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Request still pending","paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Invalid propertyId"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"No active connection found for this property. The API returns 403 rather than 404 in this case.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/403/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1{propertyId}~1connection/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Request still pending","paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Invalid propertyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Request still pending","paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Invalid propertyId"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/403/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1connection/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/{propertyId}/connection"},{"label":"Retrieve multiple active connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections/getactiveconnections","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connections/getactiveconnections","metadata":{"seo":{"title":"Retrieve multiple active connections","description":"List all active connections you have with properties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActiveConnections","name":"Retrieve multiple active connections","isWebhook":false,"pointer":"/paths/~1properties~1-~1connections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multiple active connections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all active connections you have with properties."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the results by when connection types were activated, and by the connection types a connection includes or is missing. Results are paginated. To navigate between pages, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.prev_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_time","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connections with at least one connection type activated on or after this date and time (UTC). Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2018-10-10T12:34:56Z"},{"name":"end_time","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connections with at least one connection type activated before this date and time (UTC). Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2018-10-10T12:34:56Z"},{"name":"connection_type","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connections containing all of the specified connection types. To specify multiple connection types, repeat the parameter, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connection_type=PHOTOS&connection_type=CONTENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A comma-separated list is not supported."},"children":[]}]}]}]},{"name":"missing_connection_type","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connections not containing any of the specified connection types. To specify multiple connection types, repeat the parameter, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_connection_type=PHOTOS&missing_connection_type=CONTENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A comma-separated list is not supported."},"children":[]}]}]}]},{"name":"page_size","in":"query","schemaId":"schema_4","description":"Maximum number of items to return per page."},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque cursor for fetching the next or previous page. To paginate, use the full URL from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.prev_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly rather than extracting the cursor value."},"children":[]}]}]}]},{"name":"order_by","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for results. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field_name asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field_name desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supported fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connected_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_connected_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The sort direction defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and can be omitted. To sort by both fields, separate them with a comma, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_connected_at desc, connected_at asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1properties~1-~1connections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/-/connections","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"start_time","in":"query","example":"2018-10-10T12:34:56Z","schemaId":"schema_2"},{"name":"end_time","in":"query","example":"2018-10-10T12:34:56Z","schemaId":"schema_2"},{"name":"connection_type","in":"query","schemaId":"schema_3"},{"name":"missing_connection_type","in":"query","schemaId":"schema_3"},{"name":"page_size","in":"query","schemaId":"schema_4"},{"name":"cursor","in":"query","schemaId":"schema_5"},{"name":"order_by","in":"query","schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/properties/-/connections","href":"connections/getactiveconnections","openApiOperationId":"getActiveConnections","summary":"Retrieve multiple active connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveConnectionsResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ActiveConnectionsResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/200/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid cursor"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid cursor"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1-~1connections/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveConnectionsResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveConnectionsResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid cursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid cursor"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1connections/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1connections/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/-/connections"}],"content":{"contentType":"group","meta":{"name":"Connections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connections","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve and deactivate active connections with properties."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/properties/{propertyId}/connection","summary":"Retrieve a single active connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connections/getactiveconnection","deprecated":false},{"title":"/properties/{propertyId}/connection","summary":"Deactivate an active connection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/connections/deactivate","deprecated":false},{"title":"/properties/-/connections","summary":"Retrieve multiple active connections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connections/getactiveconnections","deprecated":false}]}]}]}]}},{"type":"group","label":"Requests","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests","items":[{"label":"Approve a pending connection request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/approve","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/approve","metadata":{"seo":{"title":"Approve a pending connection request","description":"Accept a pending connection request from a property. On success, the request becomes an active connection and the endpoint returns the connection details. To accept requests from multiple properties, call this endpoint once for each property ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"approve","name":"Approve a pending connection request","isWebhook":false,"pointer":"/paths/~1properties~1{propertyId}~1request:approve/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve a pending connection request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept a pending connection request from a property. On success, the request becomes an active connection and the endpoint returns the connection details. To accept requests from multiple properties, call this endpoint once for each property ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body is optional. Use it to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing_model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The pricing model only applies when the request includes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AVAILABILITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection type. You must be certified to use a pricing model other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm the scope of the connection with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connection_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you specify connection types, they must exactly match the connection types the property requested. Otherwise, the endpoint returns an error."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"propertyId","in":"path","schemaId":"schema_0","description":"The Booking.com property ID.","required":true}],"pointer":"/paths/~1properties~1{propertyId}~1request:approve/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApproveRequestBody","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/requestBody/content/application~1json/examples/Approve with pricing model and connection types"]}},"schemaId":"components/schemas/ApproveRequestBody","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/requestBody/content/application~1json/examples/Approve with pricing model and connection types"],"pointer":"/paths/~1properties~1{propertyId}~1request:approve/post/requestBody","description":"Optional. Specify the pricing model and confirm the connection types you intend to approve."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/properties/{propertyId}/request:approve","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[{"name":"propertyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApproveRequestBody","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/requestBody/content/application~1json/examples/Approve with pricing model and connection types"]}},"responseCodes":["200","400","401","403","500"],"pointer":"/properties/{propertyId}/request:approve","href":"requests/approve","openApiOperationId":"approve","summary":"Approve a pending connection request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"schemaId":"components/schemas/ApproveRequestBody","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/requestBody/content/application~1json/examples/Approve with pricing model and connection types"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApproveRequestBody","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/requestBody/content/application~1json/examples/Approve with pricing model and connection types"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/200/content/application~1json/examples/Request approved"]}},"schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/200/content/application~1json/examples/Request approved"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection type mismatch","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Invalid propertyId"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection type mismatch","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Invalid propertyId"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"The provider is not certified for the selected pricing model, or no pending connection request was found for this property. The API returns 403 rather than 404 when no request is found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Not certified for pricing model","paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Request not found"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Not certified for pricing model","paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Request not found"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1{propertyId}~1request:approve/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/200/content/application~1json/examples/Request approved"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveConnectionResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/200/content/application~1json/examples/Request approved"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection type mismatch","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Invalid propertyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection type mismatch","paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Invalid propertyId"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Not certified for pricing model","paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Request not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Not certified for pricing model","paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Request not found"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request:approve/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/{propertyId}/request:approve"},{"label":"Retrieve a single pending request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/getconnectionrequest","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/getconnectionrequest","metadata":{"seo":{"title":"Retrieve a single pending request","description":"Retrieve details about a pending connection request from a property."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConnectionRequest","name":"Retrieve a single pending request","isWebhook":false,"pointer":"/paths/~1properties~1{propertyId}~1request/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a single pending request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve details about a pending connection request from a property."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This endpoint only checks for pending requests. If no pending request is found, the endpoint returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. This happens both when the property is not connected to you at all and when it has an active connection."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"propertyId","in":"path","schemaId":"schema_0","description":"The Booking.com property ID.","required":true}],"pointer":"/paths/~1properties~1{propertyId}~1request/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/{propertyId}/request","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[{"name":"propertyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/properties/{propertyId}/request","href":"requests/getconnectionrequest","openApiOperationId":"getConnectionRequest","summary":"Retrieve a single pending request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectionRequestResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request found","paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request not found"]}},"schemaId":"components/schemas/ConnectionRequestResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request found","paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request not found"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/400/content/application~1json/examples/Invalid propertyId"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/400/content/application~1json/examples/Invalid propertyId"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1{propertyId}~1request/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectionRequestResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request found","paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectionRequestResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request found","paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request not found"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/400/content/application~1json/examples/Invalid propertyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/400/content/application~1json/examples/Invalid propertyId"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/{propertyId}/request"},{"label":"Reject a pending connection request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/reject","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/reject","metadata":{"seo":{"title":"Reject a pending connection request","description":"Reject a pending connection request from a property. On successful rejection, the endpoint returns a 200 OK response without a data field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reject","name":"Reject a pending connection request","isWebhook":false,"pointer":"/paths/~1properties~1{propertyId}~1request/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject a pending connection request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reject a pending connection request from a property. On successful rejection, the endpoint returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no pending request is found, the endpoint returns an error. The error tells you whether you already have an active connection with the property:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with error code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1900"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You have an active connection with the property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with error code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"635"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You have neither a pending request nor an active connection with the property."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"propertyId","in":"path","schemaId":"schema_0","description":"The Booking.com property ID.","required":true}],"pointer":"/paths/~1properties~1{propertyId}~1request/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/properties/{propertyId}/request","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[{"name":"propertyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/properties/{propertyId}/request","href":"requests/reject","openApiOperationId":"reject","summary":"Reject a pending connection request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/200/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Invalid propertyId"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Invalid propertyId"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"No pending connection request found for this property. The API returns 403 rather than 404 in this case.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/403/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1{propertyId}~1request/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Invalid propertyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Connection already active","paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Invalid propertyId"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/403/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1request/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/{propertyId}/request"},{"label":"Retrieve multiple pending requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/getconnectionrequests","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/requests/getconnectionrequests","metadata":{"seo":{"title":"Retrieve multiple pending requests","description":"List pending connection requests from properties. Review the request details, and then accept or reject each request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConnectionRequests","name":"Retrieve multiple pending requests","isWebhook":false,"pointer":"/paths/~1properties~1-~1requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multiple pending requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List pending connection requests from properties. Review the request details, and then accept or reject each request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter the results by when requests were sent, and by the connection types a request includes or is missing. Results are paginated. To navigate between pages, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.prev_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_time","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connection requests sent on or after this date and time (UTC). Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2018-10-10T12:34:56Z"},{"name":"end_time","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connection requests sent before this date and time (UTC). Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2018-10-10T12:34:56Z"},{"name":"connection_type","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connection requests containing all of the specified connection types. To specify multiple connection types, repeat the parameter, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connection_type=PHOTOS&connection_type=CONTENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A comma-separated list is not supported."},"children":[]}]}]}]},{"name":"missing_connection_type","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include connection requests not containing any of the specified connection types. To specify multiple connection types, repeat the parameter, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_connection_type=PHOTOS&missing_connection_type=CONTENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A comma-separated list is not supported."},"children":[]}]}]}]},{"name":"page_size","in":"query","schemaId":"schema_4","description":"Maximum number of items to return per page."},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque cursor for fetching the next or previous page. To paginate, use the full URL from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.prev_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly rather than extracting the cursor value."},"children":[]}]}]}]},{"name":"order_by","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for results. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field_name asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field_name desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supported field: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requested_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1properties~1-~1requests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/-/requests","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"start_time","in":"query","example":"2018-10-10T12:34:56Z","schemaId":"schema_2"},{"name":"end_time","in":"query","example":"2018-10-10T12:34:56Z","schemaId":"schema_2"},{"name":"connection_type","in":"query","schemaId":"schema_3"},{"name":"missing_connection_type","in":"query","schemaId":"schema_3"},{"name":"page_size","in":"query","schemaId":"schema_4"},{"name":"cursor","in":"query","schemaId":"schema_5"},{"name":"order_by","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/properties/-/requests","href":"requests/getconnectionrequests","openApiOperationId":"getConnectionRequests","summary":"Retrieve multiple pending requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectionRequestsResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectionRequestsResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/200/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid cursor"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid cursor"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1-~1requests/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectionRequestsResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectionRequestsResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid cursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid cursor"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1requests/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1requests/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/-/requests"}],"content":{"contentType":"group","meta":{"name":"Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Requests","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve, approve, and reject pending connection requests from properties."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/properties/{propertyId}/request:approve","summary":"Approve a pending connection request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/requests/approve","deprecated":false},{"title":"/properties/{propertyId}/request","summary":"Retrieve a single pending request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/requests/getconnectionrequest","deprecated":false},{"title":"/properties/{propertyId}/request","summary":"Reject a pending connection request","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/requests/reject","deprecated":false},{"title":"/properties/-/requests","summary":"Retrieve multiple pending requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/requests/getconnectionrequests","deprecated":false}]}]}]}]}},{"type":"group","label":"Disconnection summaries","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/disconnection-summaries","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/disconnection-summaries","items":[{"label":"Retrieve disconnection summary for multiple properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/disconnection-summaries/getdisconnectionsummaries","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/disconnection-summaries/getdisconnectionsummaries","metadata":{"seo":{"title":"Retrieve disconnection summary for multiple properties","description":"Retrieve disconnection summaries for all properties you previously managed, grouped by property."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDisconnectionSummaries","name":"Retrieve disconnection summary for multiple properties","isWebhook":false,"pointer":"/paths/~1properties~1-~1disconnection-summaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve disconnection summary for multiple properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve disconnection summaries for all properties you previously managed, grouped by property."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A property can therefore have a disconnection summary while it still has an active connection with you. For example, if a property keeps the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESERVATIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection type but switches its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection type to a specialised provider, its summary shows the disconnection time of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fully_disconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shows whether the property currently has no active connection with you. Summaries only include disconnections on or after 1 October 2023, 00:00 UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are paginated. To navigate between pages, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.prev_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_time","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2018-10-10T12:34:56Z"},{"name":"end_time","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDThh:mm:ssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2018-10-10T12:34:56Z"},{"name":"page_size","in":"query","schemaId":"schema_4","description":"Maximum number of items to return per page."},{"name":"cursor","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque cursor for fetching the next or previous page. To paginate, use the full URL from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.prev_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly rather than extracting the cursor value."},"children":[]}]}]}]},{"name":"order_by","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for results. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field_name asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field_name desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supported field: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_disconnected_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"disconnection_type","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include properties that were partially disconnected ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), fully disconnected ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or either ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Values are case-insensitive. Uppercase is the canonical form."},"children":[]}]}]}]}],"pointer":"/paths/~1properties~1-~1disconnection-summaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/-/disconnection-summaries","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"start_time","in":"query","example":"2018-10-10T12:34:56Z","schemaId":"schema_2"},{"name":"end_time","in":"query","example":"2018-10-10T12:34:56Z","schemaId":"schema_2"},{"name":"page_size","in":"query","schemaId":"schema_4"},{"name":"cursor","in":"query","schemaId":"schema_5"},{"name":"order_by","in":"query","schemaId":"schema_8"},{"name":"disconnection_type","in":"query","schemaId":"schema_9"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/properties/-/disconnection-summaries","href":"disconnection-summaries/getdisconnectionsummaries","openApiOperationId":"getDisconnectionSummaries","summary":"Retrieve disconnection summary for multiple properties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DisconnectionSummariesResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DisconnectionSummariesResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/200/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid cursor","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid disconnection_type"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid cursor","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid disconnection_type"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1-~1disconnection-summaries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DisconnectionSummariesResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DisconnectionSummariesResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid cursor","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid disconnection_type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid page_size","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid order_by","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid time format","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid cursor","paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid disconnection_type"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1-~1disconnection-summaries/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/-/disconnection-summaries"},{"label":"Retrieve a disconnection summary for a single property","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/disconnection-summaries/getdisconnectionsummary","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/disconnection-summaries/getdisconnectionsummary","metadata":{"seo":{"title":"Retrieve a disconnection summary for a single property","description":"Retrieve the disconnection summary for a specific property."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDisconnectionSummary","name":"Retrieve a disconnection summary for a single property","isWebhook":false,"pointer":"/paths/~1properties~1{propertyId}~1disconnection-summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a disconnection summary for a single property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the disconnection summary for a specific property."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A property can therefore have a disconnection summary while it still has an active connection with you. For example, if a property keeps the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESERVATIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection type but switches its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection type to a specialised provider, its summary shows the disconnection time of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fully_disconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shows whether the property currently has no active connection with you. Summaries only include disconnections on or after 1 October 2023, 00:00 UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no disconnection data is found for the property, the endpoint returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"propertyId","in":"path","schemaId":"schema_0","description":"The Booking.com property ID.","required":true}],"pointer":"/paths/~1properties~1{propertyId}~1disconnection-summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/{propertyId}/disconnection-summary","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[{"name":"propertyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/properties/{propertyId}/disconnection-summary","href":"disconnection-summaries/getdisconnectionsummary","openApiOperationId":"getDisconnectionSummary","summary":"Retrieve a disconnection summary for a single property"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DisconnectionSummaryResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection found","paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection not found"]}},"schemaId":"components/schemas/DisconnectionSummaryResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection found","paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection not found"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/400/content/application~1json/examples/Invalid propertyId"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/400/content/application~1json/examples/Invalid propertyId"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1{propertyId}~1disconnection-summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DisconnectionSummaryResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection found","paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DisconnectionSummaryResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection found","paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection not found"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/400/content/application~1json/examples/Invalid propertyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/400/content/application~1json/examples/Invalid propertyId"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/{propertyId}/disconnection-summary"}],"content":{"contentType":"group","meta":{"name":"Disconnection summaries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disconnection summaries","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve per-property summaries of partial and full disconnections."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/properties/-/disconnection-summaries","summary":"Retrieve disconnection summary for multiple properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disconnection-summaries/getdisconnectionsummaries","deprecated":false},{"title":"/properties/{propertyId}/disconnection-summary","summary":"Retrieve a disconnection summary for a single property","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disconnection-summaries/getdisconnectionsummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Connection status","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connection-status","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connection-status","items":[{"label":"Check whether a property is connected to the provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connection-status/getconnectionstatus","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/connection-status/getconnectionstatus","metadata":{"seo":{"title":"Check whether a property is connected to the provider","description":"Check the connection status between you and a property. The status field returns one of the following values:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConnectionStatus","name":"Check whether a property is connected to the provider","isWebhook":false,"pointer":"/paths/~1properties~1{propertyId}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check whether a property is connected to the provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the connection status between you and a property. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returns one of the following values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The property has an active connection with you. The response includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connected_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The property has a pending connection request. The response includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requested_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The property has neither an active connection nor a pending request with you."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"propertyId","in":"path","schemaId":"schema_0","description":"The Booking.com property ID.","required":true}],"pointer":"/paths/~1properties~1{propertyId}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/{propertyId}/status","servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"parameters":{"path":[{"name":"propertyId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/properties/{propertyId}/status","href":"connection-status/getconnectionstatus","openApiOperationId":"getConnectionStatus","summary":"Check whether a property is connected to the provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property is connected","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property has requested a connection","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property not found"]}},"schemaId":"components/schemas/StatusResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property is connected","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property has requested a connection","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property not found"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/400/content/application~1json/examples/Invalid propertyId"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/400/content/application~1json/examples/Invalid propertyId"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authentication credentials. Check that the request includes a valid Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/500/content/application~1json/example"],"headers":{"X-RUID":{"$ref":"#/components/headers/X-RUID"}},"headerSchemaId":"schema_1"}],"pointer":"/paths/~1properties~1{propertyId}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property is connected","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property has requested a connection","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property is connected","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property has requested a connection","paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property not found"]}}},{"code":"400","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/400/content/application~1json/examples/Invalid propertyId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/400/content/application~1json/examples/Invalid propertyId"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"500","schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseWithoutData","exampleIds":["paths/~1properties~1{propertyId}~1status/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/properties/{propertyId}/status"}],"content":{"contentType":"group","meta":{"name":"Connection status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connection status","showPageActions":true},{"nodeType":"markdoc","content":"Check the connection status of a property."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/properties/{propertyId}/status","summary":"Check whether a property is connected to the provider","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connection-status/getconnectionstatus","deprecated":false}]}]}]}]}},{"type":"separator","label":"Documentation","content":null},{"type":"group","label":"About Try it","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it","items":[{"type":"link","label":"Environment","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/environment","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/environment","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Environment"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/environment"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can select between two different environments (top right corner in the UI):"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock (schema only) (default)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Helps to understand the response data schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for all write operations (POST, PUT, PATCH, DELETE)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment for testing without affecting live/test data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to use only test properties as the requests hit the production endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes will affect your test property data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires valid credentials"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Request","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/request","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/request","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Request"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click on any unresolved placeholders to add a value or edit an existing placeholder value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portal loads the default request body. Where the specification supports multiple request body examples (for example: Rooms API POST endpoint), you can choose a different request body from the drop-down list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some helpful pointers before running a request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (when using production endpoint): Configure your authentication headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token (JWT) as required. Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to manage separate machine accounts for test vs. properties in production."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure credentials match your selected environment."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fill in required parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameters (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST/PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is sent to the selected environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending requests to the production endpoint, a real HTTP request is made to the API"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/response","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/response","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Try it feature provides comprehensive response information to the extent supported by the OpenAPI specification:"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Status code","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/status-code","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/status-code","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Status code"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/status-code"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status code"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success responses (200)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Client errors (400 Bad Request, 401 Unauthorized, 404 Not Found)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Server errors (500 Internal Server Error)"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response body","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/response-body","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/response-body","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response body"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/response-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON formatted response data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the returned response, by default, is unformatted, select the supported Response body format in the UI."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response headers","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/response-headers","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/response-headers","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response headers"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/response-headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type, Content-Length."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Environments","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/environments","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/environments","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Environments"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab allows you to create variables specific to the environment. For example, you can add a variable to hold the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder. The portal inserts the respective value depending on the environment at the time of sending the request."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Variables","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/variables","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/variables","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Variables"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most of the endpoints (especially POST/PUT/PATCH/DELETE) require you to add a path or query parameter before sending the request. Path parameters use single braces in the OpenAPI specification (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{propertyId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The portal's Environments tab lets you store values for these parameters as reusable variables."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Path parameters","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/path-parameters","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/path-parameters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Path parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/path-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Must be provided to make the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Ensures correct data types (integer, string, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/properties/{propertyId}/resource"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Query parameters","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/query-parameters","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/query-parameters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Query parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Usually have default values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the default value"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Request body","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/request-body","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/request-body","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Request body"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Follows OpenAPI schema definitions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Prepopulated with sample values"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Best practices","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/best-practices","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/best-practices","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Best practices"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides some basic practice guidelines."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Authentication","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/authentication","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/authentication","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always use separate machine accounts for test properties vs. properties in production."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When testing with the production endpoint, make sure to use only test properties."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Read operations (GET)","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/for-read-operations-(get)","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/for-read-operations-(get)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Read operations (GET)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-read-operations-(get)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Read operations (GET)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET requests are non-mutating, but use authorised test properties when testing against the production endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use valid IDs that exist in your system"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check response structure for integration planning"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Write operations (POST, PUT, PATCH)","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/for-write-operations-(post-put-patch)","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/for-write-operations-(post-put-patch)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Write operations (POST, PUT, PATCH)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-write-operations-(post-put-patch)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Write operations (POST, PUT, PATCH)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always use Mock (schema only) environment first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify request payload structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check response for success confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test error scenarios with invalid data"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Delete operations (DELETE)","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/for-delete-operations-(delete)","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/for-delete-operations-(delete)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Delete operations (DELETE)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-delete-operations-(delete)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Delete operations (DELETE)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferable to use Mock (schema only) environment only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Understand the operation is irreversible"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have backup data when testing using test properties"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Troubleshooting","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/troubleshooting","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/troubleshooting","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Troubleshooting"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/troubleshooting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Troubleshooting"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Common issues","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/common-issues","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/common-issues","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Common issues"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/common-issues"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check authentication credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify token is valid and not expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure credentials match the selected environment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate request payload against schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check required fields are provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify data types match specification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm the resource ID exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the endpoint URL is correct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify you have access to the resource"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Getting help","link":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/getting-help","routeSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification/about-try-it/getting-help","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Getting help"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/getting-help"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting help"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you encounter issues:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the response error message for details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify your request matches the API specification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact the Connectivity Team for support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation applies to all endpoints in the API. The Try it feature provides a consistent testing experience across all operations."},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"About Try it"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"About Try it","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn how to effectively use the Try it feature in the API documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to send sample requests to API endpoints directly from the developer portal. In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock (schema only)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment, Try it returns schema-driven mock responses or pre-built example responses. In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment, it sends the request to the live API and returns dynamic responses from your selected test property."},"children":[]}]}]}]}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error or warning returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warnings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of the response."},"children":[]}]}]}],"properties":{"message":{"type":"string","description":"Error category."},"code":{"type":"integer","format":"int32","description":"Numeric error code."},"details":{"type":"object","description":"Additional information about the error.","properties":{"fields":{"type":"array","description":"The request fields or parameters that caused the error.","items":{"type":"string"}}}},"description":{"type":"string","description":"Detailed explanation of the error."}}}},"components/schemas/ApiResponseWithoutData":{"id":"components/schemas/ApiResponseWithoutData","kind":"json-schema","title":"ApiResponseWithoutData","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}},"components/schemas/ResponseMeta":{"id":"components/schemas/ResponseMeta","kind":"json-schema","title":"ResponseMeta","data":{"type":"object","properties":{"ruid":{"type":"string"}}}},"components/schemas/ActiveConnection":{"id":"components/schemas/ActiveConnection","kind":"json-schema","title":"ActiveConnection","data":{"type":"object","properties":{"legal_entity":{"$ref":"#/components/schemas/LegalEntity"},"connection_types":{"type":"object","additionalProperties":{"type":"string","format":"date-time"},"description":"Active connection types, each with the date and time (UTC) it was activated. The order of the keys is not guaranteed and can differ between responses."},"connected_at":{"type":"string","format":"date-time"},"last_connected_at":{"type":"string","format":"date-time"},"property":{"$ref":"#/components/schemas/Property"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}},"components/schemas/ActiveConnectionResponse":{"id":"components/schemas/ActiveConnectionResponse","kind":"json-schema","title":"ActiveConnectionResponse","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"data":{"$ref":"#/components/schemas/ActiveConnection"}}}},"components/schemas/LegalEntity":{"id":"components/schemas/LegalEntity","kind":"json-schema","title":"LegalEntity","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"company_name":{"type":"string"}}}},"components/schemas/Pricing":{"id":"components/schemas/Pricing","kind":"json-schema","title":"Pricing","data":{"type":"object","properties":{"currency_code":{"type":"string"},"model":{"type":"string","enum":["Standard","OBP","LOS"]}}}},"components/schemas/Property":{"id":"components/schemas/Property","kind":"json-schema","title":"Property","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"country_code":{"type":"string"},"city":{"type":"string"},"zip_code":{"type":"string"},"address":{"type":"string"}}}},"components/schemas/ActiveConnectionsResponse":{"id":"components/schemas/ActiveConnectionsResponse","kind":"json-schema","title":"ActiveConnectionsResponse","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/ActiveConnection"}}}}},"components/schemas/ConnectionRequest":{"id":"components/schemas/ConnectionRequest","kind":"json-schema","title":"ConnectionRequest","data":{"type":"object","properties":{"legal_entity":{"$ref":"#/components/schemas/LegalEntity"},"connection_types":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["RESERVATIONS","AVAILABILITY","REVIEWS","CONTENT","PHOTOS","MESSAGING","PROMOTIONS","PERFORMANCE","FACILITIES","PROPERTY_SETTINGS","PAYMENTS_ELIGIBILITY","RECONCILIATION","RESERVATION_PAYMENT_DETAILS","REPORTING","PAYMENTS","RESERVATION_PAYMENT_BREAKDOWN"]}},"requested_at":{"type":"string","format":"date-time"},"property":{"$ref":"#/components/schemas/Property"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}},"components/schemas/PaginatedResponseMeta":{"id":"components/schemas/PaginatedResponseMeta","kind":"json-schema","title":"PaginatedResponseMeta","data":{"type":"object","properties":{"prev_page":{"type":"string"},"next_page":{"type":"string"},"prev_count":{"type":"integer","format":"int32"},"next_count":{"type":"integer","format":"int32"},"ruid":{"type":"string"}}}},"components/schemas/DisconnectionSummariesResponse":{"id":"components/schemas/DisconnectionSummariesResponse","kind":"json-schema","title":"DisconnectionSummariesResponse","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/DisconnectionSummary"}}}}},"components/schemas/DisconnectionSummary":{"id":"components/schemas/DisconnectionSummary","kind":"json-schema","title":"DisconnectionSummary","data":{"type":"object","properties":{"property_id":{"type":"integer","format":"int64"},"connection_types":{"type":"object","additionalProperties":{"type":"string","format":"date-time"},"description":"Connection types the property previously had with you but does not have now, each with the date and time (UTC) it was disconnected. The order of the keys is not guaranteed and can differ between responses."},"fully_disconnected":{"type":"boolean"},"last_disconnected_at":{"type":"string","format":"date-time"}}}},"components/schemas/DisconnectionSummaryResponse":{"id":"components/schemas/DisconnectionSummaryResponse","kind":"json-schema","title":"DisconnectionSummaryResponse","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"data":{"$ref":"#/components/schemas/DisconnectionSummary"}}}},"components/schemas/ApproveRequestBody":{"id":"components/schemas/ApproveRequestBody","kind":"json-schema","title":"ApproveRequestBody","data":{"type":"object","properties":{"pricing_model":{"type":"string","enum":["Standard","OBP","LOS"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing model for the connection. Only applies when the request includes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AVAILABILITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection type. You must be certified to use a pricing model other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Values are case-insensitive."},"children":[]}]}]}]},"connection_types":{"type":"array","items":{"type":"string","enum":["RESERVATIONS","AVAILABILITY","REVIEWS","CONTENT","PHOTOS","MESSAGING","PROMOTIONS","PERFORMANCE","FACILITIES","PROPERTY_SETTINGS","PAYMENTS_ELIGIBILITY","RECONCILIATION","RESERVATION_PAYMENT_DETAILS","REPORTING","PAYMENTS","RESERVATION_PAYMENT_BREAKDOWN"]}}}}},"components/schemas/ConnectionRequestResponse":{"id":"components/schemas/ConnectionRequestResponse","kind":"json-schema","title":"ConnectionRequestResponse","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"data":{"$ref":"#/components/schemas/ConnectionRequest"}}}},"components/schemas/ConnectionRequestsResponse":{"id":"components/schemas/ConnectionRequestsResponse","kind":"json-schema","title":"ConnectionRequestsResponse","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionRequest"}}}}},"components/schemas/ConnectionStatus":{"id":"components/schemas/ConnectionStatus","kind":"json-schema","title":"ConnectionStatus","data":{"type":"object","properties":{"property_id":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["not found","pending","connected"]},"requested_at":{"type":"string","format":"date-time"},"connected_at":{"type":"string","format":"date-time"}}}},"components/schemas/StatusResponse":{"id":"components/schemas/StatusResponse","kind":"json-schema","title":"StatusResponse","data":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"data":{"$ref":"#/components/schemas/ConnectionStatus"}}}},"components/schemas/UnauthorizedError":{"id":"components/schemas/UnauthorizedError","kind":"json-schema","title":"UnauthorizedError","data":{"type":"object","description":"Error item returned when authentication fails. The API currently returns this item with empty values.","properties":{"message":{"type":"string","description":"Error category. Currently returned as an empty string."},"code":{"type":"string","description":"Error code. Currently returned as an empty string, unlike other errors, which return an integer."},"details":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the error. Currently returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/UnauthorizedResponse":{"id":"components/schemas/UnauthorizedResponse","kind":"json-schema","title":"UnauthorizedResponse","data":{"type":"object","description":"Response returned when authentication fails.","properties":{"meta":{"$ref":"#/components/schemas/ResponseMeta"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedError"}}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"object","properties":{"X-RUID":{"type":"string","format":"uuid","description":"Unique request ID. Include this value when contacting support."}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["RESERVATIONS","AVAILABILITY","REVIEWS","CONTENT","PHOTOS","MESSAGING","PROMOTIONS","PERFORMANCE","FACILITIES","PROPERTY_SETTINGS","PAYMENTS_ELIGIBILITY","RECONCILIATION","RESERVATION_PAYMENT_DETAILS","REPORTING","PAYMENTS","RESERVATION_PAYMENT_BREAKDOWN"]}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":10},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","default":"connected_at asc"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","default":"requested_at asc"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","default":"last_disconnected_at asc"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","default":"ANY","enum":["ANY","PARTIAL","FULL"]},"id":"schema_9"}},"exampleStore":{"paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{"legal_entity":{"id":1231231,"company_name":"Best Holiday Homes"},"connection_types":{"REVIEWS":"2022-01-01T01:23:45Z","CONTENT":"2022-01-01T01:23:45Z","REPORTING":"2022-01-01T01:23:45Z","RESERVATIONS":"2022-01-01T01:23:45Z","PHOTOS":"2023-07-01T12:34:56Z","AVAILABILITY":"2022-01-01T01:23:45Z"},"connected_at":"2022-01-01T01:23:45Z","last_connected_at":"2023-07-01T12:34:56Z","property":{"id":11223344,"name":"The Fake Hotel","country_code":"es","city":"Malaga","zip_code":"12321","address":"Via Booking 123"},"pricing":{"currency_code":"EUR","model":"Standard"}}},"key":"Connection found","summary":"Connection found","description":"Connection found","id":"paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection found"},"paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection not found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{}},"key":"Connection not found","summary":"Connection not found","description":"Connection not found","id":"paths/~1properties~1{propertyId}~1connection/get/responses/200/content/application~1json/examples/Connection not found"},"paths/~1properties~1{propertyId}~1connection/get/responses/400/content/application~1json/examples/Invalid propertyId":{"value":{"meta":{"ruid":"b7ded176-9b75-4fc7-b866-16b88d38d202"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["path param propertyId"]},"description":"Invalid value for path parameter propertyId"}]},"key":"Invalid propertyId","summary":"Invalid propertyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is not a valid property ID."},"children":[]}]}]}],"id":"paths/~1properties~1{propertyId}~1connection/get/responses/400/content/application~1json/examples/Invalid propertyId"},"paths/~1properties~1{propertyId}~1connection/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1{propertyId}~1connection/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1{propertyId}~1connection/get/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1{propertyId}~1connection/get/responses/500/content/application~1json/example"},"paths/~1properties~1{propertyId}~1connection/delete/responses/200/content/application~1json/example":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[]},"id":"paths/~1properties~1{propertyId}~1connection/delete/responses/200/content/application~1json/example"},"paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Request still pending":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Not applicable to resource","code":1900,"description":"Connection not found - pending connection request exists"}]},"key":"Request still pending","summary":"Request still pending","description":"Request still pending","id":"paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Request still pending"},"paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Invalid propertyId":{"value":{"meta":{"ruid":"b7ded176-9b75-4fc7-b866-16b88d38d202"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["path param propertyId"]},"description":"Invalid value for path parameter propertyId"}]},"key":"Invalid propertyId","summary":"Invalid propertyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is not a valid property ID."},"children":[]}]}]}],"id":"paths/~1properties~1{propertyId}~1connection/delete/responses/400/content/application~1json/examples/Invalid propertyId"},"paths/~1properties~1{propertyId}~1connection/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1{propertyId}~1connection/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1{propertyId}~1connection/delete/responses/403/content/application~1json/example":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Data not found","code":635,"description":"Connection not found"}]},"id":"paths/~1properties~1{propertyId}~1connection/delete/responses/403/content/application~1json/example"},"paths/~1properties~1{propertyId}~1connection/delete/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1{propertyId}~1connection/delete/responses/500/content/application~1json/example"},"paths/~1properties~1-~1connections/get/responses/200/content/application~1json/example":{"value":{"meta":{"next_page":"https://supply-xml.booking.com/connections-api/properties/-/connections?page_size=10&order_by=connected_at%20desc&cursor=AAAAAACrQTAAAAAAAGSgHXA","prev_count":0,"next_count":1023,"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":[{"legal_entity":{"id":1231231,"company_name":"Best Holiday Homes"},"connection_types":{"REVIEWS":"2022-01-01T01:23:45Z","CONTENT":"2022-01-01T01:23:45Z","REPORTING":"2022-01-01T01:23:45Z","RESERVATIONS":"2022-01-01T01:23:45Z","PHOTOS":"2023-07-01T12:34:56Z","AVAILABILITY":"2022-01-01T01:23:45Z"},"connected_at":"2022-01-01T01:23:45Z","last_connected_at":"2023-07-01T12:34:56Z","property":{"id":11223344,"name":"The Fake Hotel","country_code":"es","city":"Malaga","zip_code":"12321","address":"Via Booking 123"},"pricing":{"currency_code":"EUR","model":"Standard"}}]},"id":"paths/~1properties~1-~1connections/get/responses/200/content/application~1json/example"},"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid page_size":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param page_size"]},"description":"Invalid page size requested"}]},"key":"Invalid page_size","summary":"Invalid page_size","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid page_size"},"children":[]}]}]}],"id":"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid page_size"},"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid order_by":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param order_by"]},"description":"Sorting field 'created_at' not supported here"}]},"key":"Invalid order_by","summary":"Invalid order_by","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid order_by"},"children":[]}]}]}],"id":"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid order_by"},"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid time format":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param start_time"]},"description":"Invalid start time format"}]},"key":"Invalid time format","summary":"Invalid time format","description":"Invalid time format","id":"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid time format"},"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid cursor":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param cursor"]},"description":"Invalid or malformed cursor"}]},"key":"Invalid cursor","summary":"Invalid cursor","description":"Invalid cursor","id":"paths/~1properties~1-~1connections/get/responses/400/content/application~1json/examples/Invalid cursor"},"paths/~1properties~1-~1connections/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1-~1connections/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1-~1connections/get/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1-~1connections/get/responses/500/content/application~1json/example"},"paths/~1properties~1{propertyId}~1request:approve/post/requestBody/content/application~1json/examples/Approve with pricing model and connection types":{"value":{"pricing_model":"Standard","connection_types":["AVAILABILITY","PHOTOS","RESERVATIONS","REVIEWS","REPORTING","CONTENT"]},"key":"Approve with pricing model and connection types","summary":"Approve with pricing model and connection types","description":"Approve a request using the Standard pricing model and confirm the requested connection types.","id":"paths/~1properties~1{propertyId}~1request:approve/post/requestBody/content/application~1json/examples/Approve with pricing model and connection types"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/200/content/application~1json/examples/Request approved":{"value":{"meta":{"ruid":"4589148f-c8ca-44ad-8b14-e3a909d602a3"},"warnings":[],"errors":[],"data":{"legal_entity":{"id":12345,"company_name":"XYZ Test Inc"},"connection_types":{"REVIEWS":"2023-08-03T14:06:22Z","CONTENT":"2023-08-03T14:06:22Z","PHOTOS":"2023-08-03T14:06:22Z","AVAILABILITY":"2023-08-03T14:06:22Z","REPORTING":"2023-08-03T14:06:22Z","RESERVATIONS":"2023-08-03T14:06:22Z"},"connected_at":"2023-08-03T14:06:22Z","last_connected_at":"2023-08-03T14:06:22Z","property":{"id":8011855,"name":"HillTop Hotel","country_code":"nl","city":"Amsterdam","zip_code":"1000 VL","address":"Nieuwe straat 157"},"pricing":{"currency_code":"EUR","model":"Standard"}}},"key":"Request approved","summary":"Request approved","description":"The connection request was approved and is now an active connection.","id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/200/content/application~1json/examples/Request approved"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection already active":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Not applicable to resource","code":1900,"description":"Connection request not found - active connection exists"}]},"key":"Connection already active","summary":"Connection already active","description":"Connection already active","id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection already active"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection type mismatch":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value for resource","code":1901,"details":{"fields":["$.connection_types"]},"description":"Connection types in payload do not match the pending connections types "}]},"key":"Connection type mismatch","summary":"Connection type mismatch","description":"Connection type mismatch","id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Connection type mismatch"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Invalid propertyId":{"value":{"meta":{"ruid":"b7ded176-9b75-4fc7-b866-16b88d38d202"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["path param propertyId"]},"description":"Invalid value for path parameter propertyId"}]},"key":"Invalid propertyId","summary":"Invalid propertyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is not a valid property ID."},"children":[]}]}]}],"id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/400/content/application~1json/examples/Invalid propertyId"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Not certified for pricing model":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Authorization error","code":497,"details":{"fields":["$.pricing_model"]},"description":"Provider not certified for the selected pricing model "}]},"key":"Not certified for pricing model","summary":"Not certified for pricing model","description":"Not certified for pricing model","id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Not certified for pricing model"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Request not found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Data not found","code":635,"description":"Connection request not found"}]},"key":"Request not found","summary":"Request not found","description":"Request not found","id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/403/content/application~1json/examples/Request not found"},"paths/~1properties~1{propertyId}~1request:approve/post/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1{propertyId}~1request:approve/post/responses/500/content/application~1json/example"},"paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{"legal_entity":{"id":1231231,"company_name":"Best Holiday Homes"},"connection_types":["REVIEWS","CONTENT","REPORTING","RESERVATIONS","PHOTOS","AVAILABILITY"],"requested_at":"2023-07-01T12:34:56Z","property":{"id":11223344,"name":"The Fake Hotel","country_code":"es","city":"Malaga","zip_code":"12321","address":"Via Booking 123"},"pricing":{"currency_code":"EUR","model":"Standard"}}},"key":"Request found","summary":"Request found","description":"Request found","id":"paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request found"},"paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request not found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{}},"key":"Request not found","summary":"Request not found","description":"Request not found","id":"paths/~1properties~1{propertyId}~1request/get/responses/200/content/application~1json/examples/Request not found"},"paths/~1properties~1{propertyId}~1request/get/responses/400/content/application~1json/examples/Invalid propertyId":{"value":{"meta":{"ruid":"b7ded176-9b75-4fc7-b866-16b88d38d202"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["path param propertyId"]},"description":"Invalid value for path parameter propertyId"}]},"key":"Invalid propertyId","summary":"Invalid propertyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is not a valid property ID."},"children":[]}]}]}],"id":"paths/~1properties~1{propertyId}~1request/get/responses/400/content/application~1json/examples/Invalid propertyId"},"paths/~1properties~1{propertyId}~1request/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1{propertyId}~1request/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1{propertyId}~1request/get/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1{propertyId}~1request/get/responses/500/content/application~1json/example"},"paths/~1properties~1{propertyId}~1request/delete/responses/200/content/application~1json/example":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[]},"id":"paths/~1properties~1{propertyId}~1request/delete/responses/200/content/application~1json/example"},"paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Connection already active":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Not applicable to resource","code":1900,"description":"Connection request not found - active connection exists"}]},"key":"Connection already active","summary":"Connection already active","description":"Connection already active","id":"paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Connection already active"},"paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Invalid propertyId":{"value":{"meta":{"ruid":"b7ded176-9b75-4fc7-b866-16b88d38d202"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["path param propertyId"]},"description":"Invalid value for path parameter propertyId"}]},"key":"Invalid propertyId","summary":"Invalid propertyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is not a valid property ID."},"children":[]}]}]}],"id":"paths/~1properties~1{propertyId}~1request/delete/responses/400/content/application~1json/examples/Invalid propertyId"},"paths/~1properties~1{propertyId}~1request/delete/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1{propertyId}~1request/delete/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1{propertyId}~1request/delete/responses/403/content/application~1json/example":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Data not found","code":635,"description":"Connection request not found"}]},"id":"paths/~1properties~1{propertyId}~1request/delete/responses/403/content/application~1json/example"},"paths/~1properties~1{propertyId}~1request/delete/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1{propertyId}~1request/delete/responses/500/content/application~1json/example"},"paths/~1properties~1-~1requests/get/responses/200/content/application~1json/example":{"value":{"meta":{"next_page":"https://supply-xml.booking.com/connections-api/properties/-/requests?page_size=10&order_by=requested_at%20desc&cursor=AAAAAACrQTAAAAAAAGSgHXA","prev_count":0,"next_count":1023,"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":[{"legal_entity":{"id":1231231,"company_name":"Best Holiday Homes"},"connection_types":["REVIEWS","CONTENT","REPORTING","RESERVATIONS","PHOTOS","AVAILABILITY"],"requested_at":"2023-07-01T12:34:56Z","property":{"id":11223344,"name":"The Fake Hotel","country_code":"es","city":"Malaga","zip_code":"12321","address":"Via Booking 123"},"pricing":{"currency_code":"EUR","model":"Standard"}}]},"id":"paths/~1properties~1-~1requests/get/responses/200/content/application~1json/example"},"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid page_size":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param page_size"]},"description":"Invalid page size requested"}]},"key":"Invalid page_size","summary":"Invalid page_size","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid page_size"},"children":[]}]}]}],"id":"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid page_size"},"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid order_by":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param order_by"]},"description":"Sorting field 'created_at' not supported here"}]},"key":"Invalid order_by","summary":"Invalid order_by","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid order_by"},"children":[]}]}]}],"id":"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid order_by"},"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid time format":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param start_time"]},"description":"Invalid start time format"}]},"key":"Invalid time format","summary":"Invalid time format","description":"Invalid time format","id":"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid time format"},"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid cursor":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param cursor"]},"description":"Invalid or malformed cursor"}]},"key":"Invalid cursor","summary":"Invalid cursor","description":"Invalid cursor","id":"paths/~1properties~1-~1requests/get/responses/400/content/application~1json/examples/Invalid cursor"},"paths/~1properties~1-~1requests/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1-~1requests/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1-~1requests/get/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1-~1requests/get/responses/500/content/application~1json/example"},"paths/~1properties~1-~1disconnection-summaries/get/responses/200/content/application~1json/example":{"value":{"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":[{"property_id":2154097,"connection_types":{"CONTENT":"2022-11-06T11:10:56Z","REPORTING":"2022-11-06T11:10:56Z","RESERVATIONS":"2023-12-11T22:11:00Z","MESSAGING":"2022-11-06T11:10:56Z","REVIEWS":"2022-11-06T11:10:56Z","PHOTOS":"2022-11-06T11:10:56Z","AVAILABILITY":"2023-12-11T22:11:00Z"},"fully_disconnected":true,"last_disconnected_at":"2023-12-11T22:11:00Z"},{"property_id":6867813,"connection_types":{"MESSAGING":"2023-11-14T10:18:38Z","REVIEWS":"2023-11-14T10:18:39Z"},"fully_disconnected":false,"last_disconnected_at":"2023-11-14T10:18:39Z"}]},"id":"paths/~1properties~1-~1disconnection-summaries/get/responses/200/content/application~1json/example"},"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid page_size":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param page_size"]},"description":"Invalid page size requested"}]},"key":"Invalid page_size","summary":"Invalid page_size","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid page_size"},"children":[]}]}]}],"id":"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid page_size"},"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid order_by":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param order_by"]},"description":"Sorting field 'created_at' not supported here"}]},"key":"Invalid order_by","summary":"Invalid order_by","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid order_by"},"children":[]}]}]}],"id":"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid order_by"},"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid time format":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param start_time"]},"description":"Invalid start time format"}]},"key":"Invalid time format","summary":"Invalid time format","description":"Invalid time format","id":"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid time format"},"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid cursor":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["query param cursor"]},"description":"Invalid or malformed cursor"}]},"key":"Invalid cursor","summary":"Invalid cursor","description":"Invalid cursor","id":"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid cursor"},"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid disconnection_type":{"value":{"meta":{"ruid":"914a30f5-f540-4df5-9435-dca3e625bebf"},"warnings":[],"errors":[{"message":"Unable to process","code":450,"description":"query param disconnection_type must be one of [ANY, PARTIAL, FULL]"}]},"key":"Invalid disconnection_type","summary":"Invalid disconnection_type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnection_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not one of the accepted values."},"children":[]}]}]}],"id":"paths/~1properties~1-~1disconnection-summaries/get/responses/400/content/application~1json/examples/Invalid disconnection_type"},"paths/~1properties~1-~1disconnection-summaries/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1-~1disconnection-summaries/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1-~1disconnection-summaries/get/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1-~1disconnection-summaries/get/responses/500/content/application~1json/example"},"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{"property_id":2154097,"connection_types":{"RESERVATIONS":"2023-11-06T11:10:56Z","REVIEWS":"2023-11-06T11:10:56Z","REPORTING":"2023-11-06T11:10:56Z","PHOTOS":"2023-11-06T11:10:56Z","AVAILABILITY":"2023-11-06T11:10:56Z","MESSAGING":"2023-11-06T11:10:56Z","CONTENT":"2023-11-06T11:10:56Z"},"fully_disconnected":true,"last_disconnected_at":"2023-11-06T11:10:56Z"}},"key":"Disconnection found","summary":"Disconnection found","description":"Disconnection found","id":"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection found"},"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection not found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{}},"key":"Disconnection not found","summary":"Disconnection not found","description":"Disconnection not found","id":"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/200/content/application~1json/examples/Disconnection not found"},"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/400/content/application~1json/examples/Invalid propertyId":{"value":{"meta":{"ruid":"b7ded176-9b75-4fc7-b866-16b88d38d202"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["path param propertyId"]},"description":"Invalid value for path parameter propertyId"}]},"key":"Invalid propertyId","summary":"Invalid propertyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is not a valid property ID."},"children":[]}]}]}],"id":"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/400/content/application~1json/examples/Invalid propertyId"},"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1{propertyId}~1disconnection-summary/get/responses/500/content/application~1json/example"},"paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property is connected":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{"property_id":11223344,"status":"connected","connected_at":"2022-01-01T01:23:45Z"}},"key":"Property is connected","summary":"Property is connected","description":"Property is connected","id":"paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property is connected"},"paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property has requested a connection":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{"property_id":11223344,"status":"pending","requested_at":"2022-01-01T01:23:45Z"}},"key":"Property has requested a connection","summary":"Property has requested a connection","description":"Property has requested a connection","id":"paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property has requested a connection"},"paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property not found":{"value":{"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"},"warnings":[],"errors":[],"data":{"property_id":11223344,"status":"not found"}},"key":"Property not found","summary":"Property not found","description":"Property not found","id":"paths/~1properties~1{propertyId}~1status/get/responses/200/content/application~1json/examples/Property not found"},"paths/~1properties~1{propertyId}~1status/get/responses/400/content/application~1json/examples/Invalid propertyId":{"value":{"meta":{"ruid":"b7ded176-9b75-4fc7-b866-16b88d38d202"},"warnings":[],"errors":[{"message":"Invalid value","code":320,"details":{"fields":["path param propertyId"]},"description":"Invalid value for path parameter propertyId"}]},"key":"Invalid propertyId","summary":"Invalid propertyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is not a valid property ID."},"children":[]}]}]}],"id":"paths/~1properties~1{propertyId}~1status/get/responses/400/content/application~1json/examples/Invalid propertyId"},"paths/~1properties~1{propertyId}~1status/get/responses/401/content/application~1json/examples/Unauthorized":{"value":{"meta":{"ruid":"85480d1e-e205-45c3-bee5-36011e291b72"},"warnings":[],"errors":[{"message":"","code":"","details":null}]},"key":"Unauthorized","summary":"Authentication failed","description":"The request was not authenticated. The error item contains no code or message.","id":"paths/~1properties~1{propertyId}~1status/get/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1properties~1{propertyId}~1status/get/responses/500/content/application~1json/example":{"value":{"warnings":[],"errors":[{"message":"System error","code":448,"description":"Internal server error"}],"meta":{"ruid":"fee464e7-1b41-4834-b665-b2aeba62ba7d"}},"id":"paths/~1properties~1{propertyId}~1status/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication. Use your API credentials to obtain a JWT."}},"servers":[{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","isMockServer":true,"description":"Mock (schema only)"},{"url":"https://supply-xml.booking.com/connections-api","description":"Production Environment"}],"specType":"openapi"},"options":{"feedback":{"hide":true,"settings":{"label":""}},"corsProxyUrl":"https://cors.redoc.ly","pagination":"section","mockServer":{"url":"/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification","position":"first","description":"Mock (schema only)","off":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connectivity/docs/openapispecs/connections-api/connections-api-specification.json?download"},{"url":"/_bundle/connectivity/docs/openapispecs/connections-api/connections-api-specification.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Connections API","description":"**Connections API** allows connectivity providers to manage their connections with properties.\nIt is an alternative to managing connections manually in the Provider Portal or relying on the emails Booking.com sends\nabout new connection requests.\n\n**Note**: For providers, *“managing connections”* means deciding what to do with connection requests made\nby properties (accepting or rejecting them), deactivating connections, and retrieving updates about\nconnections. This helps providers keep their own records up to date and limit errors when using other APIs.\n\n**This API differs from most Connectivity APIs.** Most Connectivity APIs allow providers to perform actions on behalf\nof properties, such as managing availability or retrieving reservations. In contrast, Connections API is meant to be\nused by providers for their own purposes: to manage how they themselves are connected to properties. In other words,\nmost APIs support actions otherwise available to properties in the Extranet, while Connections API supports actions\navailable to providers in the Provider Portal.\n\n## Connections\n\nIn the context of this API:\n- A “**connection**” is an abstraction of all ***active** connection types* between a provider and a property within\nBooking.com Connectivity.\n- By that definition, there cannot be multiple connections between one provider and one property.\n- A connection is the basis for accessing Connectivity APIs on behalf of the property.\n- One connection consists of one or more distinct connection types. The connection types indirectly specify what\nactions the provider is permitted to perform on the property.\n- (Pending) connection **requests** are distinct from (active) connections. A connection request is not yet\na connection, but it can become one if the provider approves it. A connection request is an abstraction of all\n***pending** connection types* between a provider and a property within Booking.com Connectivity.\n- A provider and a property cannot have both an active connection and a pending request at the same time.\nTherefore, the “connection state” between any given provider and property is either a connection, a request, or\nneither, but never a mix of them.\n\n## Selected user scenarios\n\nThe following are examples of what providers can do with this API:\n\n- Listing recent connection requests to review them and approve or reject them.\n- Checking whether a specific property’s request is still pending, for example, after taking manual actions in the\nprovider’s interface and just before accepting it.\n- Checking whether a specific property (one known to the provider by its Booking.com property ID and willing to\nconnect with them) has already requested a connection, that is, has a pending request.\n- Listing recent connection requests to check whether a property known by name, but not by Booking.com property ID,\nhas already requested a connection.\n- Retrieving a specific property’s request to verify that it is correct, for example, the requested connection types.\n- Listing all pending connection requests to clean up old or missed requests.\n- Listing recently disconnected properties to update their status in the provider’s database, or to follow up with\nproperties about unexpected disconnections.\n- Listing recent partial disconnections to stop using APIs that are no longer available.\n- Listing the properties that are missing a certain connection type or permission, so that the provider can request\nadditional connection types from them.\n- Retrieving the details of the connection with an already-connected property to check whether a request for\nadditional connection types succeeded.\n\n## API resources\n\nFrom the provider’s perspective, there are three distinct resource types related to connections:\n\n- Pending connection requests\n- Active connections\n- Disconnections\n\nA provider’s **requests** and **active connections** are uniquely identified by the Booking.com property ID.\n\nDisconnection data is grouped into per-property summaries, a convenient way to think about and retrieve it.\nAs a result, **disconnection summaries** are also uniquely identified by the property ID.\n\nAdditionally, a lightweight **status** resource lets you check the connection status of a property.\n\n## Related APIs\n\nYou may need more information before accepting a connection request. For example, details of the commission or tax\nsetup can be relevant for proper mapping. To avoid redundancy with other APIs, Connections API does not include this\ninformation. For commission details, use the `GetCommissionOverride` endpoint. Tax data is included in\n`OTA_HotelDescriptiveInfo`."}},"baseSlug":"/connectivity/docs/openapispecs/connections-api/connections-api-specification","routesMapping":{}}