openapi: 3.0.0 info: title: Octorate Integration Central description: >-

Introduction

The Octorate Api is made up by REST calls. Our API follows common predictable resource-oriented URLS, accept query params bodies and returns JSON-encoded response. It uses these following standard verbs: - POST - DELETE - PATCH - GET And the usually given HTTP Response code (200, 404, etc.., check glossary of common errors for details) You can use our Api in test mode, that means that interacting with them doesn't effect the listings or the content of the user. The Authentication according to the agreement you've got with us is usually performed through an Oauth code that has a limited temporary expiration. As secondary authentication method we may accept also an "Api Key". The authentication must be provided in every http calls you made inside the HEADER.

Manual And tutorials

Please refer to the upper link Integration Central to see tutorial, FAQ and quick start guides

Glossary of commons errors

CodeFull NameDetailed descriptionWay to fix it
Category 400 - Errors in your request
400Bad RequestGeneric Bad request errors that means that content you've given to the server was rejected either by the server or the application server. Check the format of your request and whether you're providing the right content-type headers.
400ApiParamsExemptionApplication server accepted the call, but the validation of the params failed, means that you're presenting you're request to the right endpoint and with the right format, but the content is the issue there and you're missing some required param or the value is not acceptable.. Check carefully the details to check what's missing or not set corretcly, recheck examples.
400JsonParseExemptionProbably the endpoint is right, the content type is right, but you've given a malformed json, check in a json validator online if your json structure is right.. Use an online tool to validate your json and check where was malformed.
400ApiValidationFailedYou're request is good, your content is good, all required params are given, but it failes our internal constraints (For instance this call can be wellformed but you missed some required calls before) Please check the content inside or push the other content that misses.
Category 401 - Permission issues
401ApiKeyMissingYou've not given the access key at allCheck the headers of your call
401ApiKeyInvalidYou're presenting the api key, but this api key is wrongCheck whether the api key provided is the right one (or the access token)
Category 403 - Access Forbidden
403ApiSecurityExceptionYou have not the permission to access the requested resource (i.e. you're trying to get access of the resource not owned by the provided property) Check if the resource is the wanted you want to access. If it is a new customer you may ask the user with oauth to the auth to access this resource
403ApiQuotaExceptionYou've reached your quota limitsWait for new quota, optimize your calls in order to do as few as you can
403WrongEnviromentYou are trying to execute a production call in sandbox or viceversa or in the wrong enviromentCheck where are you trying to execute your call
Category 404 - Resource not found/available
404NotFound (no json details provided)This error tells you that you're trying to call a link that doesn't exists. It can also means that the sandbox env. is not reacheable Try in a few minutes if you're working on sandbox. Check the link you're calling, the slash, the endpoint and the typos.
404ApiResourceMissingThis error tells you a specific resource doesn't exist. It's possible that the resource has been moved or deleted, or that there's a typo in your request. Make sure the resource exists.
404ApiResourceEmptyUsed in content in order to allow you to understand that the relative object/resource was never filled at tall Try pushing the resource.
Category 405 - Method not allowed
405MethodNotAllowedThe requested method and resource are not compatible. See the Allow header for this resource's available methods. This error means that the requested resource does not support the HTTP method you used. Find out which methods are allowed (GET,POST,etc...) for each resource in the API Reference
Category 422 - Unprocessable entity
422ApiResourceMissingThe request was well-formed but was unable to be followed due to semantic errors.
Category 5xx - Application/Server issues
500InternalServerErrorAn unexpected internal error has occurred.Please contact Support for more information.
550ApiPartnerServerErrorOne of our partner that was called to take in charge the request has failed to execute it.please check the details to try to understand why, feel free to contact the partner or octorate at second stage.
Contact Support: Email: tech@octorate.com version: 1.0.0 servers: - url: http://{{octorate}} - url: http://{{baseurl}} - url: http://localhost:8080 components: securitySchemes: oauth2Auth: type: http scheme: oauth2 bearerAuth: type: http scheme: bearer apikeyAuth: type: http scheme: apikey noauthAuth: type: http scheme: noauth security: - oauth2Auth: [] tags: - name: rest/v1 - name: rest/v1 > Each User One Login description: >- Use the generated token in the Authorization tab of "Each User One Login" to obtain a token - name: rest/v1 > Each User One Login > roomrates - name: rest/v1 > Each User One Login > connection - name: rest/v1 > Each User One Login > connection > {accommodation} - name: >- rest/v1 > Each User One Login > connection > {accommodation} > {connection} - name: >- rest/v1 > Each User One Login > connection > external/{accommodation}/{connection} - name: >- rest/v1 > Each User One Login > connection > mapping/{accommodation}/{connection} - name: rest/v1 > Each User One Login > pms - name: rest/v1 > Each User One Login > pms > meta - name: rest/v1 > Each User One Login > content - name: rest/v1 > Each User One Login > content > connections - name: rest/v1 > Each User One Login > content > connections > {connection} - name: >- rest/v1 > Each User One Login > content > connections > {connection} > cancellation Policies - name: >- rest/v1 > Each User One Login > content > connections > {connection} > contacts - name: >- rest/v1 > Each User One Login > content > connections > {connection} > fees - name: >- rest/v1 > Each User One Login > content > connections > {connection} > services - name: >- rest/v1 > Each User One Login > content > connections > {connection} > accommodationconf - name: >- rest/v1 > Each User One Login > content > connections > {connection} > extrabeds - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > availabilityconf - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > descriptions - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > fees - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > listing - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > pricing - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rate - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > reservation - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rooms - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > photos - name: >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > amenities - name: rest/v1 > Each User One Login > checkin/{accommodation} - name: rest/v1 > Each User One Login > checkin/{accommodation} > {reservation Id} - name: >- rest/v1 > Each User One Login > checkin/{accommodation} > {reservation Id} > guest/{guest Id} - name: rest/v1 > Each User One Login > calendar - name: rest/v1 > Each User One Login > calendar > {accommodation} - name: rest/v1 > Each User One Login > accommodation - name: rest/v1 > Each User One Login > accommodation > network - name: rest/v1 > Each User One Login > accommodation > network > {network} - name: rest/v1 > Each User One Login > accommodation > {accommodation} - name: rest/v1 > Each User One Login > accommodation > {accommodation} > photos - name: rest/v1 > Each User One Login > accommodation > {accommodation} > queue - name: rest/v1 > Each User One Login > extra/{accommodation} - name: rest/v1 > Each User One Login > chat - name: rest/v1 > Each User One Login > reservation - name: rest/v1 > Each User One Login > reservation > {accommodation} - name: rest/v1 > Each User One Login > reservation > {accommodation} > {id} - name: >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > extra - name: >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > extra > {extra Id} - name: >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > payment - name: rest/v1 > Each User One Login > reservation > Split - name: rest/v1 > Each User One Login > MetaData - name: rest/v1 > Each User One Login > MetaData > meta - name: rest/v1 > Each User One Login > invoice - name: rest/v1 > Each User One Login > Affiliate - name: rest/v1 > Each User One Login > Payment - name: rest/v1 > Each User One Login > portal - name: rest/v1 > Each User One Login > Tags - name: rest/v1 > Api Admin Operation - name: rest/v1 > Api Admin Operation > subscription - name: rest/v1 > Api Admin Operation > subscription > {id} - name: rest/v1 > Api Admin Operation > portal/apiportal - name: rest/v1 > Api Admin Operation > identity - name: rest/v1 > Api Admin Operation > api/configuration - name: rest/v1 > Api Admin Operation > accommodation - name: rest/v2 [Experimental] - name: rest/v2 [Experimental] > Each User One Login - name: rest/v2 [Experimental] > Each User One Login > reservation - name: rest/v2 [Experimental] > Each User One Login > payment - name: rest/v2 [Experimental] > Each User One Login > invoices paths: /connect/rest/v1/roomrates/{accommodation}: get: tags: - rest/v1 > Each User One Login > roomrates summary: Retrieve all the property room and rates description: >- Through this call you can retrieve all the Inventory of Octorate platform.
Please take note, we consider both typology or rate as products. We don't yet allow to separate them and mixing after.
We define the relationship between these products using the field derivedRule where you can setup the relationship between the current object and the parent (i.e. +5 eur, follow avail,etc..)
We strongly suggest you to have also a look to the backoffice of the user to understand better how this products are linked.
New accommodation or new product for an apartment? All depends on where the linked services should be located. I.e. we support sending statistical data and sending information to the police setting up only one credential for accommodation. If you're sure that all the products belongs to the same configuration you can set up them inside the same property (An example might be defining the building, with always the same external credentials, and inside the single apartment as products) parameters: - name: fields in: query schema: type: string example: id,name,accommodationId,aggregateChildren,basicName,derivedRule - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '340888' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - adults: 49005735 bathroomQuantity: 88130016 bedQuantity: 89923420 bedroomQuantity: -23706900 breakfastIncluded: false closeNextDays: 0 minimumSellingPrice: 100.23 name: Double room notRefundable: true statistic: false tripeThePrice: false id: -4968146 children: -78508337 infants: 76042132 dormitory: false quantity: 1 squareMetersSize: 23 legalIdIssuer: State of New York, tourism office legalId: MC123FG1 derivedRule: parent: -7677607 availability: true stay: false restrictions: true stopSell: false price: INCREMENT priceValue: 81911251.09910971 priceRound: false headline: EN: These are the LanguageMap value in English! - adults: -77824673 bathroomQuantity: 12137630 bedQuantity: 53695079 bedroomQuantity: 87404108 breakfastIncluded: false closeNextDays: 0 minimumSellingPrice: 100.23 name: Double room notRefundable: true statistic: true tripeThePrice: false id: -89837777 children: -63019859 infants: 42990058 dormitory: false quantity: 1 squareMetersSize: 23 legalIdIssuer: State of New York, tourism office legalId: MC123FG1 derivedRule: parent: -5664390 availability: false stay: true restrictions: true stopSell: false price: INCREMENT priceValue: -23227747.670567125 priceRound: false headline: EN: These are the LanguageMap value in English! '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - rest/v1 > Each User One Login > roomrates summary: create a room or a rate requestBody: content: '*/*': schema: type: string example: >- "{\n \"name\":\"Appartamento Deluxe_BOOKING\",\n \"adults\":2,\n \"children\":0,\n \"infants\":0,\n \"dormitory\":false,\n \"notRefundable\":false,\n \"breakfastIncluded\":false,\n \"statistic\":false,\n \"quantity\":3,\n \"bathroomQuantity\":0,\n \"bedroomQuantity\":0,\n \"bedQuantity\":0,\n \"squareMetersSize\":0,\n \"legalIdIssuer\":null,\n \"legalId\":null,\n \"minimumSellingPrice\":90.00,\n \"derivedRule\":null,\n \"headline\":null,\n \"description\":null,\n \"tripeThePrice\":false,\n \"closeNextDays\":0,\n \"headlineLangMap\":null,\n \"descriptionLangMap\":null\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '94906' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - id: 207677 name: TEST EXTRA accommodation: currency: EUR id: '112696' name: La Pergola di Venezia timeZone: Europe/Rome enabled: false mandatory: false refundable: false basePrice: 0 description: {} model: BOOKING taxPercent: 0 title: {} - id: 207678 name: TEST EXTRA accommodation: currency: EUR id: '112696' name: La Pergola di Venezia timeZone: Europe/Rome enabled: false mandatory: false refundable: false basePrice: 0 description: {} model: BOOKING taxPercent: 0 title: {} '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/roomrates/{accommodation}/{roomid}: patch: tags: - rest/v1 > Each User One Login > roomrates summary: create a room or a rate Copy requestBody: content: '*/*': schema: type: string example: >- "{\n \"statistic\": false,\n \"name\": \"La casa di Amedeo-AMEDEO N2 X4\",\n \"quantity\": 1,\n \"adults\": 4,\n \"minimumSellingPrice\": 66.01,\n \"notRefundable\": true,\n \"breakfastIncluded\": false,\n \"closeNextDays\": 0,\n \"triplePrice\": false,\n \"derivedRule\": {\n \"availability\": true,\n \"parent\": 554504\n }\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '167851' - name: roomid in: path schema: type: integer required: true example: '554510' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - id: 207677 name: TEST EXTRA accommodation: currency: EUR id: '112696' name: La Pergola di Venezia timeZone: Europe/Rome enabled: false mandatory: false refundable: false basePrice: 0 description: {} model: BOOKING taxPercent: 0 title: {} - id: 207678 name: TEST EXTRA accommodation: currency: EUR id: '112696' name: La Pergola di Venezia timeZone: Europe/Rome enabled: false mandatory: false refundable: false basePrice: 0 description: {} model: BOOKING taxPercent: 0 title: {} '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' get: tags: - rest/v1 > Each User One Login > roomrates summary: get Room parameters: - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '374456' - name: roomid in: path schema: type: integer required: true description: '(Required) ' example: '398668' responses: '200': description: OK headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/roomrates/{accommodation}/{product}/suite: post: tags: - rest/v1 > Each User One Login > roomrates summary: create Suite description: >- Aggregate rooms in order to create a suite: Let the availability be the same between many rooms. You could have for instance the Single App. + Single App.. that may be booked together in the Suite Appar. requestBody: content: {} parameters: - name: children[] in: query schema: type: number description: >- Array of products to add to this suite. Keep care: They should be base rooms (in availability) and not a suite example: '-41387376' - name: accommodation in: path schema: type: string required: true description: (Required) The accommodation where you want to operate example: qui velit - name: product in: path schema: type: number required: true description: >- (Required) The product you want to aggregate. Keep care: All derived rules existing on this room will be cleared. Number of sellable rooms for this product will be set to 1 example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - adults: 49005735 bathroomQuantity: 88130016 bedQuantity: 89923420 bedroomQuantity: -23706900 breakfastIncluded: false closeNextDays: 0 minimumSellingPrice: 100.23 name: Double room notRefundable: true statistic: false tripeThePrice: false id: -4968146 children: -78508337 infants: 76042132 dormitory: false quantity: 1 squareMetersSize: 23 legalIdIssuer: State of New York, tourism office legalId: MC123FG1 derivedRule: parent: -7677607 availability: true stay: false restrictions: true stopSell: false price: INCREMENT priceValue: 81911251.09910971 priceRound: false headline: EN: These are the LanguageMap value in English! - adults: -77824673 bathroomQuantity: 12137630 bedQuantity: 53695079 bedroomQuantity: 87404108 breakfastIncluded: false closeNextDays: 0 minimumSellingPrice: 100.23 name: Double room notRefundable: true statistic: true tripeThePrice: false id: -89837777 children: -63019859 infants: 42990058 dormitory: false quantity: 1 squareMetersSize: 23 legalIdIssuer: State of New York, tourism office legalId: MC123FG1 derivedRule: parent: -5664390 availability: false stay: true restrictions: true stopSell: false price: INCREMENT priceValue: -23227747.670567125 priceRound: false headline: EN: These are the LanguageMap value in English! '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/roomrates/{accommodation}/{productId}: delete: tags: - rest/v1 > Each User One Login > roomrates summary: delete Product description: Delete a product (room or rate) parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Accommodation Id example: qui velit - name: productId in: path schema: type: number required: true description: (Required) Room or Rate Id example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/roomrates/{accommodation}/{id}: patch: tags: - rest/v1 > Each User One Login > roomrates summary: Update the specified room or a rate requestBody: content: '*/*': schema: type: string example: >- "{\n \"id\": 523739,\n \"name\": \"Appartamento Blu-prova123\",\n \"adults\": 1,\n \"children\": 0,\n \"bathroomQuantity\": 0,\n \"bedQuantity\": 1,\n \"bedroomQuantity\": 1,\n \"bookingEngine\": true,\n \"breakfastIncluded\": false,\n \"calendar\": true,\n \"closeNextDays\": 0,\n \"description\": {},\n \"dormitory\": false,\n \"headline\": {},\n \"infants\": 0,\n \"labels\": {},\n \"manualReservations\": true,\n \"minimumSellingPrice\": 10.0,\n \"notRefundable\": true,\n \"policeCode\": \"null\",\n \"quantity\": 0,\n \"statistic\": false,\n \"tripeThePrice\": false,\n \"tripleThePrice\": false,\n \"website\": true,\n \"aggregateChildren\": [],\n \"frontName\": {}\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '578650' - name: id in: path schema: type: integer required: true description: '(Required) ' example: '445719' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: adults: 5 '304': description: Not Modified headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/rateplans/{accommodation}: get: tags: - rest/v1 > Each User One Login > roomrates summary: Retrieve RatePlan parameters: - name: fields in: query schema: type: string - name: accommodation in: path schema: type: integer required: true example: '16997' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/roomrates/{accommodation}/{roomid}/image: post: tags: - rest/v1 > Each User One Login > roomrates summary: Internal Photo Update requestBody: content: application/json: schema: type: object example: - id: 1926196 name: 1639747124088.jpg repository: ROOM sortOrder: 2 type: JPEG url: https://resx.octorate.com/content/681002/1639747124088.jpg security: - bearerAuth: [] parameters: - name: accommodation in: path schema: type: integer required: true example: '681002' - name: roomid in: path schema: type: integer required: true example: '438390' responses: '200': description: Successful response content: application/json: {} get: tags: - rest/v1 > Each User One Login > roomrates summary: Internal Photo Req security: - bearerAuth: [] parameters: - name: accommodation in: path schema: type: integer required: true example: '681002' - name: roomid in: path schema: type: integer required: true example: '438390' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/room/longRunning: get: tags: - rest/v1 > Each User One Login > roomrates summary: LONG RUN responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/roomrates/{accommodation}/{roomid}/image/{imageId}/move/2: post: tags: - rest/v1 > Each User One Login > roomrates summary: Internal Photo Move requestBody: content: application/json: schema: type: object example: id: 1926196 name: 1639747124088.jpg repository: ROOM sortOrder: 2 type: JPEG url: https://resx.octorate.com/content/681002/1639747124088.jpg security: - bearerAuth: [] parameters: - name: accommodation in: path schema: type: integer required: true example: '681002' - name: roomid in: path schema: type: integer required: true example: '438390' - name: imageId in: path schema: type: integer required: true example: '1926196' responses: '200': description: Successful response content: application/json: {} /rest/v1/connection/{accommodation}/{connection}: delete: tags: - >- rest/v1 > Each User One Login > connection > {accommodation} > {connection} summary: Delete Connection description: >- Delete a portal connection. Keep care: Remember that you might need to erase the mapping parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Accommodation Id example: qui velit - name: connection in: path schema: type: number required: true description: (Required) Connection Id example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 58519061 id: 58567302 channelName: non quis hotelId: ut occaecat fugiat irure userLogged: true updateCalendar: true pullReservations: true pullMappedOnly: true content: true mailOnError: false calendarValues: - MAXSTAY - CUTOFF username: 'id reprehenderit enim ' loginAt: ut in correctionRatio: 8376378.866454408 correctionFixed: true correctionRound: false commission: 87671999.95877993 availabilityPercentage: 100 '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' patch: tags: - >- rest/v1 > Each User One Login > connection > {accommodation} > {connection} summary: Update a connection description: >- Update a connection updating only the specified fields. Validation is performed against license, and activable connection (login, mapping,etc...) requestBody: content: '*/*': schema: type: string example: '"{\n \"messages\": true\n}"' parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '656558' - name: connection in: path schema: type: integer required: true description: '(Required) ' example: '105455' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 58519061 id: 58567302 channelName: non quis hotelId: ut occaecat fugiat irure userLogged: true updateCalendar: true pullReservations: true pullMappedOnly: true content: true mailOnError: false calendarValues: - MAXSTAY - CUTOFF username: 'id reprehenderit enim ' loginAt: ut in correctionRatio: 8376378.866454408 correctionFixed: true correctionRound: false commission: 87671999.95877993 availabilityPercentage: 100 '304': description: Not Modified headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/connection/sync/{accommodation}/{connection}: post: tags: - >- rest/v1 > Each User One Login > connection > {accommodation} > {connection} summary: SYNC requestBody: content: {} parameters: - name: start in: query schema: type: string example: '2023-03-03' - name: end in: query schema: type: string example: '2024-03-01' - name: accommodation in: path schema: type: integer required: true example: '404388' - name: connection in: path schema: type: integer required: true example: '114230' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/connection/{accommodation}/: get: tags: - rest/v1 > Each User One Login > connection > {accommodation} summary: Retrieve a portal connection parameters: - name: name in: query schema: type: string description: Optional name (like) to restrict the search example: qui velit - name: accommodation in: path schema: type: integer required: true example: '16997' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/connection/{accommodation}: post: tags: - rest/v1 > Each User One Login > connection > {accommodation} summary: Create new connection requestBody: content: '*/*': schema: type: string example: >- "{\n \"channelId\": 142,\n \"updateCalendar\": false,\n \"pullReservations\": false,\n \"pullMappedOnly\": true,\n \"content\": true,\n \"mailOnError\": true,\n \"correctionRatio\": 0,\n \"correctionFixed\": false,\n \"correctionRound\": false,\n \"availabilityPercentage\": 100\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '880331' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 58519061 id: 58567302 channelName: non quis hotelId: ut occaecat fugiat irure userLogged: true updateCalendar: true pullReservations: true pullMappedOnly: true content: true mailOnError: false calendarValues: - MAXSTAY - CUTOFF username: 'id reprehenderit enim ' loginAt: ut in correctionRatio: 8376378.866454408 correctionFixed: true correctionRound: false commission: 87671999.95877993 availabilityPercentage: 100 '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/connection/external/{accommodation}/{connection}: get: tags: - >- rest/v1 > Each User One Login > connection > external/{accommodation}/{connection} summary: Retrieve external products description: List (and related ids) of the external portal products parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Accommodation Id example: qui velit - name: connection in: path schema: type: number required: true description: (Required) Connection Id example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - createTime: 2018-11-22T11:13:00Z[UTC] id: 523833 manageable: true occupancy: 4 pmsRoom: false rateId: '3101' rateName: Not Refundable without breakfast referenceId: '3758:3101' roomId: '3758' roomName: Appartamento la Torretta per 4 persone '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/connection/external/{accommodation}/{connection}: post: tags: - >- rest/v1 > Each User One Login > connection > external/{accommodation}/{connection} summary: Create an external product description: >- A combination of Room and Rate compose a Product.
For the ARI Octorate process only products so combination of room + rate. Normally we suggest you to not use this method but use the method to import them directly from the portal.
This method is usefull for the API user that handles also the OTAs when themself are otas. In this case you can create the same products you have on your site (i.e. the listing or the room+rate item) Inside Octorate, to let Octorate know what's your id.We will provide them in Content Push updates or ARI (Availability and rates inventory) Updates.
Please, remember after to associate them to the Octorate Product through the mapping method.
If you want, you can also ask the user to do the mapping on our interface. requestBody: content: '*/*': schema: type: string example: >- "{\n \"occupancy\": 84146436,\n \"roomId\": \"magna laboris pariatur consequat dolor\",\n \"roomName\": \"quis aliquip pariatur occaecat qui\",\n \"id\": -58756377,\n \"rateName\": \"aliqua laborum ma\",\n \"rateId\": \"occaecat reprehenderit tempor veniam nisi\",\n \"manageable\": true,\n \"pmsRoom\": false\n}" parameters: - name: Content-Type in: header schema: type: string example: '*/*' - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: mollit cillum - name: connection in: path schema: type: number required: true description: '(Required) ' example: '-91358796' responses: '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/connection/mapping/{accommodation}/{connection}: get: tags: - >- rest/v1 > Each User One Login > connection > mapping/{accommodation}/{connection} summary: Retrieve Mapping description: >- List mapping of the connections between Octorate products to related external products parameters: - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '162005' - name: connection in: path schema: type: integer required: true description: '(Required) ' example: '43952' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - externalId: 523812 id: 262466 portalConnection: 41683 productId: 2262 '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/connection/mapping/{accommodation}/{connection}: post: tags: - >- rest/v1 > Each User One Login > connection > mapping/{accommodation}/{connection} summary: Create Mapping description: >- Create a new connection between an external product and an Octorate product. We expect to always have an external item even though the ota doesn't require it because we will push prices only for connected sites. requestBody: content: '*/*': schema: type: string example: '"\"qui velit\""' security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: '*/*' - name: product in: query schema: type: number description: (Required) Internal product (room or rates) of Octorate example: '-22637726' - name: externalProduct in: query schema: type: number description: (Required) External Product (id taken by previous call) example: '-22637726' - name: query in: query schema: type: string description: >- As alternative to externalProduct, Octorate Api can try to lookup from the roomrate code (i.e. room:rate@@1) example: qui velit - name: accommodation in: path schema: type: string required: true description: (Required) Accommodation Id example: qui velit - name: connection in: path schema: type: number required: true description: (Required) Connection Id example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: externalId: 523812 id: 262466 portalConnection: 41683 productId: 2262 '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/connection/mapping/{accommodation}/{connection}/{mappingId}: delete: tags: - >- rest/v1 > Each User One Login > connection > mapping/{accommodation}/{connection} summary: delete Mapping description: Delete an existing mapping security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Accommodation Id example: qui velit - name: connection in: path schema: type: number required: true description: (Required) Connection Id example: '-22637726' - name: mappingId in: path schema: type: number required: true description: (Required) Mapping id retrieved from the previous connection example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/connection/import/{accommodation}/{connection}: post: tags: - rest/v1 > Each User One Login > connection summary: Import external rooms description: >- Import the external rooms. That action will trigger the request to import room,rates or listing inside octorate. requestBody: content: {} parameters: - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: qui velit - name: connection in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - externalId: 523812 id: 262466 portalConnection: 41683 productId: 2262 '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '550': headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/connection/{action}/{accommodation}/{connection}: post: tags: - rest/v1 > Each User One Login > connection summary: Execute Action description: >- Import the external rooms. That action will trigger the request to import room,rates or listing inside octorate. requestBody: content: {} parameters: - name: action in: path schema: type: string required: true example: IMPORT_ROOMS - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '955809' - name: connection in: path schema: type: integer required: true description: '(Required) ' example: '82043' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - externalId: 523812 id: 262466 portalConnection: 41683 productId: 2262 '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '550': headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/connection: get: tags: - rest/v1 > Each User One Login > connection summary: Retrieve a portal connection security: - bearerAuth: [] parameters: - name: hotelId in: query schema: type: string example: df8a4b94-83df-488e-8b05-f5994846f424 responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/meta/contentPageFields: get: tags: - rest/v1 > Each User One Login > pms > meta summary: Retrieve content page meta description: >- Retrieve the page elements for pushing the room, you can use them in according with portal configuration to setup the page to push responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/meta/portals: get: tags: - rest/v1 > Each User One Login > pms > meta summary: OT As List description: Retrieve available portals responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: banner: ea mollit esse ut contentMetas: - sunt sint pariatur - et magna externalName: Booking.com internalName: 'Your api name with underscore: i.e. my_api_name' loginUrl: myapp.com/backoffice/ website: www.booking.com calendarValues: - STOPSELL - CLOSEARR colorHex: c5c5c5 logo: >- To Write: https://www.mywebsite.com/myimage.jpg, In reading: 123432434234.jpg id: 4 creatable: true featureContent: true featureContentRate: false octorateManageable: true '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/meta/cities: get: tags: - rest/v1 > Each User One Login > pms > meta summary: 'CHK: Cities' description: Load all the available cities for police identification parameters: - name: page in: query schema: type: number example: '-22637726' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/meta/documents: get: tags: - rest/v1 > Each User One Login > pms > meta summary: 'CHK: Documents' description: Retrieve all kind of available documents responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/meta/regions: get: tags: - rest/v1 > Each User One Login > pms > meta summary: 'CHK: Regions' description: Load all countries/districts/etc.. supported by octorate parameters: - name: page in: query schema: type: number example: '-22637726' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/meta/octorateAmenities: get: tags: - rest/v1 > Each User One Login > MetaData > meta summary: Utility Meta Amenity responses: '200': description: Successful response content: application/json: {} /rest/v1/meta/content: get: tags: - rest/v1 > Each User One Login > pms > meta summary: search Content Item parameters: - name: name in: query schema: type: string example: qui velit - name: portal in: query schema: type: string example: proident deserunt fugiat - name: category in: query schema: type: string example: CITY_TAX_NATURE responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: page: self: href: veniam pa rel: magna in nostrud Ut type: exercitation elit nisi laborum quis previous: href: laboris exercitation fugiat rel: officia type: '' next: href: in rel: laborum dolor elit ex quis type: Excepteur pariatur nulla elit page: -93094398 totalPages: 47547824 additionalInfo: {} /connect/rest/v1/pms: get: tags: - rest/v1 > Each User One Login > pms summary: find All Pms Room description: >- Retrieve all the existing pms rooms for a user accommodation and its network responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - clean: false cleaningDays: [] cleaningFrequency: 0 id: 307848 linesChangeFrequency: 0 name: '1' notes: '' parentId: 307043 timeZone: Europe/Rome - cleaningDays: - MONDAY cleaningFrequency: 0 id: 307849 linesChangeFrequency: 0 name: '1' notes: '' parentId: 307043 timeZone: Europe/Rome /rest/v1/pms/{accommodation}: get: tags: - rest/v1 > Each User One Login > pms summary: find Pms Room description: Retrieve all the existing pms rooms parameters: - name: name in: query schema: type: string description: Filter by pms room name example: qui velit - name: id in: query schema: type: number description: Filter by id example: '-22637726' - name: accommodation in: path schema: type: string required: true description: (Required) Property where look the pms rooms example: qui velit responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: >- {"data":[{"clean":false,"cleaningDays":[],"cleaningFrequency":0,"id":307848,"linesChangeFrequency":0,"name":"1","notes":"","parentId":307043,"timeZone":"Europe/Rome"},{"cleaningDays":[ "MONDAY" ],"cleaningFrequency":0,"id":307849,"linesChangeFrequency":0,"name":"1","notes":"","parentId":307043,,"timeZone":"Europe/Rome"}]} /rest/v1/content/connections/{connection}/cancellationPolicies: get: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > cancellation Policies summary: Cancellation Policies description: List current defined cancellation policies parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/connections/{connection}/cancellationPolicies: post: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > cancellation Policies summary: Cancellation Policy description: Create a new cancellation policy requestBody: content: {} parameters: - name: policy in: query schema: type: integer description: According to previously queried s, the portal value to add as policy example: '118' - name: ApplyOnDeposit in: query schema: type: boolean description: If true apply only on deposit, if false apply on reservation amount example: 'true' - name: connection in: path schema: type: integer required: true description: '(Required) The ID of the portal connection ' example: '133981' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/cancellationPolicies/{portalValue}: delete: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > cancellation Policies summary: Cancellation Policy description: Delete an existing cancellation policy parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' - name: portalValue in: path schema: type: string required: true description: '(Required) ' example: qui velit responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/connections/{connection}/contacts: get: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > contacts summary: Contacts List security: - bearerAuth: [] parameters: - name: connection in: path schema: type: integer required: true description: '(Required) The ID of the portal connection ' example: '133749' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > contacts summary: push Contact description: Contact ADD requestBody: content: '*/*': schema: type: string example: >- "{\n \"atomic\": true,\n \"codeType\": \"CONTACT_LANGUAGE\",\n \"companyName\": \"RESID'IMMOBILIER\",\n \"mail\": \"info@resid.com\",\n \"male\": true,\n \"personFamilyName\": \"CAP D'AGDE\",\n \"personName\": \"RESID IMMOBILIER\",\n \"phone\": \"+33 4 67 26 84 71\",\n \"place\": {\n \"address\": \"162 Route de rochelongue\",\n \"city\": \"LE CAP D'AGDE\",\n \"country\": \"FR\",\n \"districtName\": \"\",\n \"firstLocality\": \"LE CAP D'AGDE\",\n \"fullAddress\": \"162 Route de rochelongue, LE CAP D'AGDE, FR\",\n \"latitude\": 43.276754,\n \"longitude\": 3.480094,\n \"phone\": \"+33 4 67 26 84 71\",\n \"zipCode\": \"34300\",\n \"zoom\": 13\n },\n \"portal\": \"booking_xml\",\n \"portalValue\": \"general\",\n \"type\": \"invoices\"\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: connection in: path schema: type: integer required: true description: '(Required) The ID of the portal connection ' example: '133749' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/connections/{connection}/contacts/{type}: delete: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > contacts summary: Contact description: Remove a contact by his index parameters: - name: connection in: path schema: type: integer required: true description: '(Required) The ID of the portal connection ' example: '133981' - name: type in: path schema: type: string required: true example: general responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/fees: get: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > fees summary: Fees description: Retrieve the available external fees parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > fees summary: Fee description: Create a new Fee requestBody: content: '*/*': schema: type: string example: >- "{\n \"amount\": -68458626.47610205,\n \"chargeType\": \"PERCENT, PER_DAY, etc...\",\n \"exclusive\": false,\n \"portalValue\": \"Airbnb {PASS_THROUGH_LINEN_FEE, PASS_THROUGH_COMMUNITY_FEE,PASS_THROUGH_MANAGEMENT_FEE, PASS_THROUGH_RESORT_FEE}\",\n \"category\": \"FEE\",\n \"internetType\": \"null\",\n \"internetCoverage\": \"null\",\n \"parkingType\": \"null\",\n \"parkingNeedReservation\": false,\n \"parkingPublicArea\": false\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/fees/{index}: delete: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > fees summary: Fee description: Delete an existing fee security: - oauth2Auth: [] parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' - name: index in: path schema: type: number required: true description: (Required) Index of the fee to be deleted example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/services: get: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > services summary: Services description: Retrieve the list of services for that accommodation security: - oauth2Auth: [] parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > services summary: Service description: Add new service requestBody: content: '*/*': schema: type: string example: >- "{\n \"portal\": \"BOOKING, AIRBNB, HOMEAWAY\",\n \"quantity\": -77568003,\n \"price\": 10361657.567952693,\n \"configuration\": \"EXCLUSIVE\",\n \"exists\": false,\n \"roomLevel\": false,\n \"acceptedBreakfast\": [\n \"rep\",\n \"voluptate dolore tempor\"\n ],\n \"breakfastApplicable\": true,\n \"bookingChildren\": true,\n \"extraBed\": true,\n \"atomic\": true\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/services/{index}: delete: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > services summary: Service description: Delete an existing service security: - oauth2Auth: [] parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' - name: index in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '202': description: Accepted headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/connections/{connection}/accommodationconf: get: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > accommodationconf summary: Accommodation Settings description: >- For that specific connection, Retrieve the general Accommodation/Building settings parameters: - name: connection in: path schema: type: integer required: true description: '(Required) The ID of the portal connection ' example: '133749' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > accommodationconf summary: Accommodation Settings description: For the specific connection, describe the building settings. requestBody: content: '*/*': schema: type: string example: >- "{\n \"lastUpdate\": \"2023-08-01T05:30:56.742Z[UTC]\",\n \"maxExtraBeds\": 0,\n \"paymentMethods\": [\"VISA\"],\n \"petsChargePaid\": false,\n \"privateOperator\": true,\n \"permissionPublish\": 64816,\n \"roomQuantity\": 1,\n \"spokenLanguages\": [\"fr\"]\n}" security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: connection in: path schema: type: integer required: true description: '(Required) The ID of the portal connection ' example: '133749' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/extrabeds: get: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > extrabeds summary: Extra Beds description: Retrieve all the inserted Extra beds security: - oauth2Auth: [] parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > extrabeds summary: Extra Beds description: Insert a new Extra Bed requestBody: content: '*/*': schema: type: string example: >- "{\n \"ageRestriction\": -13546726,\n \"quantityAvailable\": 35134594,\n \"price\": 62195463.83092949\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/extrabeds/{index}: delete: tags: - >- rest/v1 > Each User One Login > content > connections > {connection} > extrabeds summary: Extra Beds description: Remove an extra bed, using his index security: - oauth2Auth: [] parameters: - name: connection in: path schema: type: number required: true description: '(Required) The ID of the portal connection ' example: '-22637726' - name: index in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/connections/{connection}/push: post: tags: - rest/v1 > Each User One Login > content > connections > {connection} summary: Final Push to Portal description: Send the accommodation to the external partner requestBody: content: {} security: - bearerAuth: [] parameters: - name: connection in: path schema: type: integer required: true description: '(Required) The ID of the portal connection ' example: '133749' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' application/json: schema: type: object example: accommodation: contacts: - mail: devin+123@octorate.com male: true personFamilyName: Rossi personName: Marios phone: '+393354866587' place: address: Via del corso city: Roma country: IT latitude: 41.90298748050708 longitude: 12.479579730603584 phone: '+393354866587' zipCode: '00172' zoom: 12 portal: booking_xml type: physicallocation - mail: devin+123@octorate.com male: true personFamilyName: Rossi personName: Marios phone: '+393354866587' place: address: Via del corso city: Roma country: IT latitude: 41.90298748050708 longitude: 12.479579730603584 phone: '+393354866587' zipCode: '00172' zoom: 12 portal: booking_xml type: invoicing - mail: devin+123@octorate.com male: true personFamilyName: Rossi personName: Marios phone: '+393354866587' place: address: Via del corso city: Roma country: IT latitude: 41.90298748050708 longitude: 12.479579730603584 phone: '+393354866587' zipCode: '00172' zoom: 12 portal: booking_xml type: contracts - mail: devin+123@octorate.com male: true personFamilyName: Rossi personName: Marios phone: '+393354866587' place: address: Via del corso city: Roma country: IT latitude: 41.90298748050708 longitude: 12.479579730603584 phone: '+393354866587' zipCode: '00172' zoom: 12 portal: booking_xml type: general extraBeds: [] lastUpdate: 2023-08-02T15:56:10.528Z[UTC] maxExtraBeds: 0 paymentMethods: - VISA petsChargePaid: false privateOperator: true propertyType: '3' roomQuantity: 1 spokenLanguages: - xu airbnbCalendarOpen: false amenitiesExternal: [] availability: advancedNotice: 0 allowRTBMaxstay: false cancellationPolicies: - afterReservation: 0 applyAfterNights: 0 applyOnDeposit: false portal: booking_xml portalValue: '118' commonSpaceShared: false descriptions: {} fees: [] listing: airbnbApprovalStatus: NEW bathroomShared: false homewayList: false photos: [] pricing: acceptToPayTaxes: false cleaningFee: 0 defaultDailyPrice: 0 discountNotRefundable: 0 guestsIncluded: 1 homeawayPricing: GUARANTEED monthlyDiscount: 0 priceExtraPerson: 0 priceExtraPersonType: null pricingUpdate: 2023-07-31T15:16:21.703Z[UTC] securityDeposit: 0 weekendPrice: 0 weeklyDiscount: 0 reservation: childrenAllowed: false eventsAllowed: false homeawayBookingPolicy: INSTANT infantsAllowed: false noticeHours: 0 petsAllowed: false smokersAllowed: false rooms: [] services: [] '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/connections/{connection}/rentalagreement: post: tags: - rest/v1 > Each User One Login > content > connections > {connection} summary: Rental Agreement description: Upload the rental agreement. MAX 5 MB requestBody: content: {} security: - oauth2Auth: [] parameters: - name: url in: query schema: type: string example: qui velit - name: connection in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/connections/meta/{portal}: get: tags: - rest/v1 > Each User One Login > content > connections summary: Read Static Portal meta description: Retrieve all the possible META custom data for a portal parameters: - name: category in: query schema: type: string description: Repetable, optional, category filter example: LANGUAGES - name: portal in: path schema: type: string required: true responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/availabilityconf: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > availabilityconf summary: get Availability description: Retrieve the availability information security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > availabilityconf summary: create Availability requestBody: content: '*/*': schema: type: string example: >- "{\n \"airbnbCheckinCategory\": \"other_checkin\",\n \"checkinInstruction\": \"reprehenderit laboris\",\n \"advancedNotice\": -14253837,\n \"defaultMinStay\": 73686685,\n \"defaultMaxStay\": 38633567,\n \"weekDayCheckin\": [\n \"SUNDAY\",\n \"SATURDAY\"\n ],\n \"weekDayCheckout\": [\n \"TUESDAY\",\n \"WEDNESDAY\"\n ]\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/descriptions: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > descriptions summary: get Descriptions security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > descriptions summary: create Description description: >- Create a new description for a room/rate, replacing existing object with the one provided. This IS NOT the octorate rate, but what the portals could receive requestBody: content: '*/*': schema: type: string example: >- "{\n \"directions\": \"Follow the A12 motorway and exit to the first exist, our house is on the left side\",\n \"description\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"houseRules\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"spaceInformation\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"access\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"hostInteraction\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"neightboorHood\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"transportation\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"details\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"paymentNotes\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"headline\": {\n \"fallback\": {\n \"EN\": \"This is the LanguageMap value in English! It's used when a portal value is not available\"\n },\n \"values\": {\n \"AIRBNB\": {\n \"IT\": \"This is a value in italian!\"\n },\n \"HOMEAWAY\": {\n \"ES\": \"This is a value in Spanish!\"\n },\n \"BOOKING\": {\n \"EN\": \"This is a value for a LanguageMap in English!\",\n \"IT\": \"This is a value in italian!\"\n }\n }\n }\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' patch: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > descriptions summary: patch Description description: >- Update an existing description for a room/rate, avoiding cancel not provided values requestBody: content: '*/*': schema: type: string example: >- "{\n \"directions\": \"Follow the A12 motorway and exit to the first exist, our house is on the left side\",\n \"description\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"houseRules\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"spaceInformation\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"access\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"hostInteraction\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"neightboorHood\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"transportation\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"details\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"paymentNotes\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n },\n \"headline\": {\n \"fallback\": {\n \"EN\": \"This is the LanguageMap value in English! It's used when a portal value is not available\"\n },\n \"values\": {\n \"AIRBNB\": {\n \"IT\": \"This is a value in italian!\"\n },\n \"HOMEAWAY\": {\n \"ES\": \"This is a value in Spanish!\"\n },\n \"BOOKING\": {\n \"EN\": \"This is a value for a LanguageMap in English!\",\n \"IT\": \"This is a value in italian!\"\n }\n }\n }\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/fees: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > fees summary: get Fees description: Retrieve the fees for an existing room/rate security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > fees summary: create Room Fee description: Create a new FEE for that room/rate requestBody: content: '*/*': schema: type: string example: >- "{\n \"portalValue\": \"Airbnb {PASS_THROUGH_LINEN_FEE, PASS_THROUGH_COMMUNITY_FEE,PASS_THROUGH_MANAGEMENT_FEE, PASS_THROUGH_RESORT_FEE}\",\n \"portal\": \"BOOKING, AIRBNB, HOMEAWAY\",\n \"chargeTypeValue\": \"Excepteur dolor\",\n \"amount\": -71150103.17094223,\n \"configuration\": \"INCLUSIVE\",\n \"category\": \"FEE\",\n \"internetDetails\": {\n \"internetType\": {\n \"country\": \"MQ\",\n \"json\": \"sint\",\n \"validationSchema\": {\n \"requiredParkingInfo\": false,\n \"requiredInternetInfo\": false\n },\n \"englishDescription\": \"Ut sed\",\n \"portalBooking\": true,\n \"convertible\": true,\n \"convertedOctorate\": {\n \"typeContent\": \"RATE_OFFER\",\n \"label\": \"anim\"\n },\n \"serializedName\": \"consequat aute pariatur ut\"\n },\n \"internetCoverage\": {\n \"country\": \"US\",\n \"json\": \"eu minim magna elit\",\n \"validationSchema\": {\n \"requiredParkingInfo\": false,\n \"requiredInternetInfo\": true\n },\n \"englishDescription\": \"dolore ea\",\n \"portalBooking\": false,\n \"convertible\": true,\n \"convertedOctorate\": {\n \"typeContent\": \"LANGUAGES\",\n \"label\": \"mollit nulla culpa\"\n },\n \"serializedName\": \"ullamco anim do\"\n }\n },\n \"parkingDetails\": {\n \"needReservation\": true,\n \"publicArea\": false,\n \"parkingType\": {\n \"country\": \"SX\",\n \"json\": \"id veniam cillum\",\n \"validationSchema\": {\n \"requiredParkingInfo\": false,\n \"requiredInternetInfo\": false\n },\n \"englishDescription\": \"sed consectetur veniam enim dolor\",\n \"portalBooking\": false,\n \"convertible\": true,\n \"convertedOctorate\": {\n \"typeContent\": \"INTERNET_CONNECTION_TYPES\",\n \"label\": \"nostrud adipisicing Duis Lorem\"\n },\n \"serializedName\": \"aliquip commodo\"\n }\n },\n \"internetFee\": true,\n \"parkingFee\": false,\n \"atomic\": false\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/fees/{index}: delete: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > fees summary: delete Room Fee description: Delete the previously found fee security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' - name: index in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/listing: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > listing summary: get Listing description: Retrieve the basic listing information security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: integer required: true description: (Required) The ID of the accommodation example: '681002' - name: productId in: path schema: type: integer required: true description: (Required) The ID of the room or rate example: '225214' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '404': description: Not Found headers: request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > listing summary: config Listing description: Create the listing information requestBody: content: '*/*': schema: type: string example: >- "{\n \"airbnbApprovalStatus\": \"NEW\",\n \"airbnbPropertyGroup\": \"unique_homes\",\n \"airbnbPropertyType\": \"shepherds_hut\",\n \"bathroomShared\": true,\n \"bathroomWith\": [\n \"family_friends_roommates\",\n \"family_friends_roommates\"\n ],\n \"bathrooms\": 5.824699561326918E7,\n \"bedrooms\": 1.0,\n \"beds\": -12884127,\n \"country\": \"TO\",\n \"homewayList\": false,\n \"internalName\": \"Apartment 2 pax\",\n \"lastEdit\": \"2020-06-30T18:32:47.542Z[UTC]\",\n \"personCapacity\": -40881911,\n \"place\": {\n \"address\": \"nulla adipisicing non\",\n \"city\": \"nu\",\n \"country\": \"MT\",\n \"districtName\": \"nostrud a\",\n \"latitude\": 7.834569542509833E7,\n \"longitude\": 5909481.111884147,\n \"phone\": \"dolore veniam\",\n \"zipCode\": \"tempor non dolore anim\",\n \"zoom\": 61601707\n },\n \"quantity\": -93120772,\n \"reference\": {\n \"portalValues\": {\n \"airbnb_xml\": \"47876663\",\n \"homeaway\": \"225214\",\n \"holidu\": \"43102792\"\n }\n },\n \"roomTypePortal\": {\n \"expedia\": \"Apartment\"\n },\n \"size\": -4.694282076367804E7\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: (Required) The ID of the accommodation example: '681002' - name: productId in: path schema: type: integer required: true description: (Required) The ID of the room or rate example: '225214' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' patch: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > listing summary: patch Listing description: Update a listing, without clear not given fields requestBody: content: '*/*': schema: type: string example: >- "{\n \"airbnbPropertyType\": \"cottage\",\n \"bathroomShared\": false,\n \"bathrooms\": -47114734.66879599,\n \"bedrooms\": 95447905.73793662,\n \"beds\": 78708568,\n \"country\": \"AI\",\n \"personCapacity\": -54975293,\n \"place\": {\n \"address\": \"consequat aliquip velit nisi\",\n \"country\": \"DO\",\n \"districtName\": \"consectetur qui\",\n \"latitude\": 76252236.41946125,\n \"longitude\": 58710926.238628,\n \"zoom\": 81422960,\n \"city\": \"culpa eu in in\",\n \"phone\": \"mollit exercitation\",\n \"zipCode\": \"aute\"\n },\n \"quantity\": 47931145,\n \"size\": 57008128.61657497,\n \"reference\": {\n \"fallback\": \"FLEXIBLE\",\n \"values\": {\n \"AIRBNB\": \"FLEXIBLE\"\n }\n },\n \"bookingPropertyGroup\": \"Double\",\n \"airbnbPropertyGroup\": \"apartments\",\n \"bathroomWith\": [\n \"other_guests\",\n \"other_guests\"\n ],\n \"taxLicenseId\": \"ut in\",\n \"airbnbRoomType\": \"private_room\",\n \"airbnbEntireHome\": false,\n \"bookingHasRoom\": false\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/pricing: post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > pricing summary: create Pricing description: >- Update an existing *pricing* for a room/rate, setting as empty not provided values requestBody: content: '*/*': schema: type: string example: >- "{\n \"securityDeposit\": 95333424.79610157,\n \"cleaningFee\": -4874297.421260864,\n \"weekendPrice\": 69267739.92771333,\n \"guestsIncluded\": -76230664,\n \"priceExtraPerson\": -25815313.402841955,\n \"priceExtraPersonType\": {\n \"values\": {\n \"empty\": true\n },\n \"fallback\": \"FIXED\",\n \"portalValues\": {\n \"empty\": true\n }\n },\n \"monthlyDiscount\": -78373287,\n \"weeklyDiscount\": 61120207,\n \"homeawayPricing\": \"GUARANTEED\"\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/products/{accommodation}/{productId}/pricing: patch: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > pricing summary: patch Pricing description: >- Update an existing *pricing* for a room/rate, without touching already provided values requestBody: content: '*/*': schema: type: string example: '"{\n \"securityDeposit\":\"10\"\n}"' security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: (Required) The ID of the accommodation example: '9912119560' - name: productId in: path schema: type: integer required: true description: (Required) The ID of the room or rate example: '187422' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/rate: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rate summary: get Rate Conf description: Retrieve the rate informations and restrictions security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rate summary: create Rate Conf description: >- Create a new rate setting up the restrictions. All not given values will be replaced with empty requestBody: content: '*/*': schema: type: string example: >- "{\n \"Name used by the property manager to identity this rate\": \"quis ullamco\",\n \"relative ids in the external channels\": {\n \"fallback\": \"FLEXIBLE\",\n \"values\": {\n \"AIRBNB\": \"FLEXIBLE\"\n }\n },\n \"(Only Agoda supports it) - Type of threatment of this rate\": {\n \"fallback\": \"FLEXIBLE\",\n \"values\": {\n \"AIRBNB\": \"FLEXIBLE\"\n }\n },\n \"(Only Agoda supports it) - Type of channel (Where sell this rate)\": \"OPAQUE_TRAVEL_PRIVATE\",\n \"(Only BookingSuite) - Relation between the parent rate (value) \": -16690397,\n \"(Only BookingSuite) - Relation between the parent rate (type) \": \"FIXED\",\n \"(Booking.com) All the appliable rate restrictions\": [\n {\n \"model\": \"ACCESS_CODE\",\n \"startDate\": \"1946-02-27T11:02:41.405Z\",\n \"endDate\": \"1965-03-26T12:56:43.684Z\",\n \"startSellStayDate\": \"1988-02-24T02:04:59.409Z\",\n \"minAdvanceDays\": 75510003,\n \"maxAdvanceDays\": -15985970,\n \"accessCode\": \"ex\",\n \"minStay\": 59674713,\n \"maxStay\": -31812792,\n \"minAdvancePeriod\": {\n \"years\": 7527816,\n \"months\": -84894191,\n \"days\": -5281327,\n \"chronology\": {\n \"id\": \"dolor eu reprehenderit in\",\n \"calendarType\": \"adipisicing nostrud amet velit dolor\"\n },\n \"units\": [\n {\n \"dateBased\": false,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": -84485785,\n \"nano\": -41056065,\n \"zero\": false,\n \"negative\": true\n },\n \"durationEstimated\": true\n },\n {\n \"dateBased\": true,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": -70040755,\n \"nano\": -83859469,\n \"zero\": false,\n \"negative\": false\n },\n \"durationEstimated\": true\n }\n ],\n \"zero\": true,\n \"negative\": false\n },\n \"maxAdvancePeriod\": {\n \"years\": 32669,\n \"months\": 89898818,\n \"days\": -60430779,\n \"chronology\": {\n \"id\": \"mollit\",\n \"calendarType\": \"Duis fugiat tempor nostrud\"\n },\n \"units\": [\n {\n \"dateBased\": false,\n \"timeBased\": false,\n \"duration\": {\n \"seconds\": -85423496,\n \"nano\": -1168952,\n \"zero\": true,\n \"negative\": false\n },\n \"durationEstimated\": false\n },\n {\n \"dateBased\": false,\n \"timeBased\": false,\n \"duration\": {\n \"seconds\": -651853,\n \"nano\": 31807146,\n \"zero\": false,\n \"negative\": true\n },\n \"durationEstimated\": true\n }\n ],\n \"zero\": true,\n \"negative\": false\n },\n \"rateMealType\": [\n \"DINNER\",\n \"FULL_BOARD\"\n ]\n },\n {\n \"model\": \"ADVANCE_DAYS\",\n \"startDate\": \"1967-03-19T10:45:51.366Z\",\n \"endDate\": \"1996-06-09T05:12:47.524Z\",\n \"startSellStayDate\": \"2000-08-11T21:37:55.526Z\",\n \"minAdvanceDays\": -53479117,\n \"maxAdvanceDays\": 38945421,\n \"accessCode\": \"dolore velit\",\n \"minStay\": -37599637,\n \"maxStay\": 76757756,\n \"minAdvancePeriod\": {\n \"years\": -73322033,\n \"months\": -19698266,\n \"days\": 28655523,\n \"chronology\": {\n \"id\": \"ex aute\",\n \"calendarType\": \"est dolor\"\n },\n \"units\": [\n {\n \"dateBased\": false,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": 36948837,\n \"nano\": -36104886,\n \"zero\": true,\n \"negative\": true\n },\n \"durationEstimated\": false\n },\n {\n \"dateBased\": false,\n \"timeBased\": false,\n \"duration\": {\n \"seconds\": 37629112,\n \"nano\": 68531640,\n \"zero\": false,\n \"negative\": false\n },\n \"durationEstimated\": false\n }\n ],\n \"zero\": true,\n \"negative\": false\n },\n \"maxAdvancePeriod\": {\n \"years\": 58421961,\n \"months\": -99162747,\n \"days\": 47384981,\n \"chronology\": {\n \"id\": \"aliqui\",\n \"calendarType\": \"ut proident velit magna ex\"\n },\n \"units\": [\n {\n \"dateBased\": true,\n \"timeBased\": false,\n \"duration\": {\n \"seconds\": 6473813,\n \"nano\": 26517604,\n \"zero\": false,\n \"negative\": false\n },\n \"durationEstimated\": true\n },\n {\n \"dateBased\": true,\n \"timeBased\": false,\n \"duration\": {\n \"seconds\": -98344156,\n \"nano\": 72007182,\n \"zero\": true,\n \"negative\": true\n },\n \"durationEstimated\": true\n }\n ],\n \"zero\": true,\n \"negative\": false\n },\n \"rateMealType\": [\n \"CONTINENTAL_BREAKFAST\",\n \"AMERICAN\"\n ]\n }\n ],\n \"derived\": [\n {\n \"occupancy\": 80459864,\n \"additionalPrice\": 97526522.85591564,\n \"percentage\": 43637229,\n \"javaId\": \"Lorem non ea dolore\",\n \"serializedName\": \"cupidatat aliquip cillum\"\n },\n {\n \"occupancy\": 8225437,\n \"additionalPrice\": -63404657.5744812,\n \"percentage\": 13503057,\n \"javaId\": \"in nostrud veniam Duis\",\n \"serializedName\": \"labore dolor irure Excepteur\"\n }\n ],\n \"javaId\": \"in\",\n \"serializedName\": \"eiusmod in cupidatat proident\"\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' patch: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rate summary: patch Room Rate description: >- Create a new rate setting up the restrictions. All not given values will be left untouched requestBody: content: '*/*': schema: type: string example: >- "{\n \"Name used by the property manager to identity this rate\": \"non reprehenderit exercitation ea\",\n \"relative ids in the external channels\": {\n \"fallback\": \"FLEXIBLE\",\n \"values\": {\n \"AIRBNB\": \"FLEXIBLE\"\n }\n },\n \"(Only Agoda supports it) - Type of threatment of this rate\": {\n \"fallback\": \"FLEXIBLE\",\n \"values\": {\n \"AIRBNB\": \"FLEXIBLE\"\n }\n },\n \"(Only Agoda supports it) - Type of channel (Where sell this rate)\": \"OPAQUE_TRAVEL_PRIVATE\",\n \"(Only BookingSuite) - Relation between the parent rate (value) \": 72299159,\n \"(Only BookingSuite) - Relation between the parent rate (type) \": \"PERCENT\",\n \"(Booking.com) All the appliable rate restrictions\": [\n {\n \"model\": \"LENGTH_OF_STAY\",\n \"startDate\": \"1971-01-27T04:54:47.280Z\",\n \"endDate\": \"1983-03-28T06:11:14.926Z\",\n \"startSellStayDate\": \"1987-10-01T01:23:17.326Z\",\n \"minAdvanceDays\": 19406244,\n \"maxAdvanceDays\": -61288967,\n \"accessCode\": \"adipisicing mollit\",\n \"minStay\": 92102261,\n \"maxStay\": 42343735,\n \"minAdvancePeriod\": {\n \"years\": -91049556,\n \"months\": 27013025,\n \"days\": -93876304,\n \"chronology\": {\n \"id\": \"eiusmod nulla\",\n \"calendarType\": \"\"\n },\n \"units\": [\n {\n \"dateBased\": true,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": -56044606,\n \"nano\": -94386989,\n \"zero\": false,\n \"negative\": true\n },\n \"durationEstimated\": false\n },\n {\n \"dateBased\": false,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": -28851511,\n \"nano\": 87077558,\n \"zero\": false,\n \"negative\": false\n },\n \"durationEstimated\": true\n }\n ],\n \"zero\": true,\n \"negative\": false\n },\n \"maxAdvancePeriod\": {\n \"years\": -31303789,\n \"months\": 43803493,\n \"days\": 39845626,\n \"chronology\": {\n \"id\": \"fugiat amet\",\n \"calendarType\": \"eiusmod\"\n },\n \"units\": [\n {\n \"dateBased\": false,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": 52822293,\n \"nano\": -81915592,\n \"zero\": true,\n \"negative\": false\n },\n \"durationEstimated\": true\n },\n {\n \"dateBased\": true,\n \"timeBased\": false,\n \"duration\": {\n \"seconds\": 30034741,\n \"nano\": 15061622,\n \"zero\": false,\n \"negative\": true\n },\n \"durationEstimated\": false\n }\n ],\n \"zero\": true,\n \"negative\": false\n },\n \"rateMealType\": [\n \"SELF_CATERING\",\n \"CARRIBBEAN_BREAKFAST\"\n ]\n },\n {\n \"model\": \"LENGTH_OF_STAY\",\n \"startDate\": \"1956-06-11T01:07:58.581Z\",\n \"endDate\": \"1990-07-21T04:59:12.112Z\",\n \"startSellStayDate\": \"1948-06-24T10:51:24.545Z\",\n \"minAdvanceDays\": -39755094,\n \"maxAdvanceDays\": 41694999,\n \"accessCode\": \"commodo ullamco dolore\",\n \"minStay\": 12145897,\n \"maxStay\": 26340003,\n \"minAdvancePeriod\": {\n \"years\": -50060793,\n \"months\": 44684380,\n \"days\": -44662018,\n \"chronology\": {\n \"id\": \"de\",\n \"calendarType\": \"elit\"\n },\n \"units\": [\n {\n \"dateBased\": true,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": -91132014,\n \"nano\": -48759506,\n \"zero\": true,\n \"negative\": true\n },\n \"durationEstimated\": false\n },\n {\n \"dateBased\": false,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": -84565103,\n \"nano\": 45326409,\n \"zero\": true,\n \"negative\": false\n },\n \"durationEstimated\": true\n }\n ],\n \"zero\": true,\n \"negative\": false\n },\n \"maxAdvancePeriod\": {\n \"years\": 87556309,\n \"months\": -61044424,\n \"days\": -66094929,\n \"chronology\": {\n \"id\": \"quis officia sunt \",\n \"calendarType\": \"occaecat elit mollit in\"\n },\n \"units\": [\n {\n \"dateBased\": false,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": 26590382,\n \"nano\": -23394169,\n \"zero\": false,\n \"negative\": true\n },\n \"durationEstimated\": true\n },\n {\n \"dateBased\": true,\n \"timeBased\": true,\n \"duration\": {\n \"seconds\": 2951696,\n \"nano\": -647445,\n \"zero\": true,\n \"negative\": false\n },\n \"durationEstimated\": false\n }\n ],\n \"zero\": true,\n \"negative\": true\n },\n \"rateMealType\": [\n \"ALL_INCLUSIVE\",\n \"CONTINENTAL_BREAKFAST\"\n ]\n }\n ],\n \"derived\": [\n {\n \"occupancy\": -38029160,\n \"additionalPrice\": -88439434.75733687,\n \"percentage\": -13653843,\n \"javaId\": \"ullamco exercitation\",\n \"serializedName\": \"eu eiusmod elit exercitation\"\n },\n {\n \"occupancy\": -24072211,\n \"additionalPrice\": 87015947.92442441,\n \"percentage\": 92315683,\n \"javaId\": \"ea adipis\",\n \"serializedName\": \"nulla esse \"\n }\n ],\n \"javaId\": \"sed Excepteur occaecat\",\n \"serializedName\": \"occaecat ma\"\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/reservation: post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > reservation summary: config Reservation description: >- Update reservation settings for a room/rate, replacing all the existing values (not given will be cleared) requestBody: content: '*/*': schema: type: string example: >- "{\n \"checkinTimeEnd\": -685609,\n \"checkinTimeStart\": 98973763,\n \"childrenExtraPrice\": -60867269.33572506,\n \"childrenAllowed\": false,\n \"childrenQuantity\": -1965470,\n \"childrenMaxAge\": -33106488,\n \"noChildrenReason\": \"ipsum ea cillum\",\n \"smokersAllowed\": false,\n \"petsAllowed\": false,\n \"eventsAllowed\": false,\n \"infantsAllowed\": false,\n \"welcomeMessage\": \"My dear guest, I looking forward to have you in my home!\",\n \"instantBookingCategory\": \"experienced_guest_with_government_id\",\n \"noticeHours\": 36538262,\n \"mininumAge\": -69851419,\n \"homeawayBookingPolicy\": \"QUOTEHOLD\",\n \"checkoutTime\": 53711124,\n \"bookingPolicy\": \"INSTANT\",\n \"cancellationPolicies\": {\n \"fallback\": \"FLEXIBLE\",\n \"values\": {\n \"AIRBNB\": \"FLEXIBLE\"\n }\n }\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' patch: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > reservation summary: patch Reservation description: >- Update reservation settings for a room/rate, without clear not given values requestBody: content: '*/*': schema: type: string example: >- "{\n \"checkinTimeEnd\": -685609,\n \"checkinTimeStart\": 98973763,\n \"childrenExtraPrice\": -60867269.33572506,\n \"childrenAllowed\": false,\n \"childrenQuantity\": -1965470,\n \"childrenMaxAge\": -33106488,\n \"noChildrenReason\": \"ipsum ea cillum\",\n \"smokersAllowed\": false,\n \"petsAllowed\": false,\n \"eventsAllowed\": false,\n \"infantsAllowed\": false,\n \"welcomeMessage\": \"My dear guest, I looking forward to have you in my home!\",\n \"instantBookingCategory\": \"experienced_guest_with_government_id\",\n \"noticeHours\": 36538262,\n \"mininumAge\": -69851419,\n \"homeawayBookingPolicy\": \"QUOTEHOLD\",\n \"checkoutTime\": 53711124,\n \"bookingPolicy\": \"INSTANT\",\n \"cancellationPolicies\": {\n \"fallback\": \"FLEXIBLE\",\n \"values\": {\n \"AIRBNB\": \"FLEXIBLE\"\n }\n }\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/rooms: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rooms summary: list Room Subrooms description: >- Retrieve all the rooms (subrooms with bed configuration) existing for the selected room/rate security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rooms summary: add Room Sub Room description: Create a new room requestBody: content: '*/*': schema: type: string example: >- "{\n \"type\": \"FRONT_YARD\",\n \"privateBathroom\": false,\n \"roomNumber\": 55852845,\n \"beds\": [\n {\n \"quantity\": -25516987,\n \"included\": false,\n \"bedType\": \"TWIN\",\n \"applicableUntilAge\": -46895332,\n \"extraPrice\": -95260121.5957817\n },\n {\n \"quantity\": -73562331,\n \"included\": false,\n \"bedType\": \"MALE_CAPSULE\",\n \"applicableUntilAge\": -36447977,\n \"extraPrice\": 95925223.58774725\n }\n ],\n \"maxGuests\": 82670545\n}" security: - oauth2Auth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/rooms/{index}: delete: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > rooms summary: delete Room Sub Room description: Delete a previously found room security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: qui velit - name: productId in: path schema: type: number required: true description: '(Required) ' example: '-22637726' - name: index in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/photos: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > photos summary: list Room Photos description: Retrieve already uploaded photos parameters: - name: accommodation in: path schema: type: integer required: true description: (Required) The ID of the accommodation example: '420901' - name: productId in: path schema: type: integer required: true description: (Required) The ID of the room or rate example: '513341' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > photos summary: upload Room Photo description: Put on queue a new photo requestBody: content: {} security: - oauth2Auth: [] parameters: - name: url in: query schema: type: string example: qui velit - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '202': description: Accepted headers: request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/photos/{photoName}: delete: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > photos summary: delete Room Photo description: Delete an already uploaded photo security: - oauth2Auth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' - name: photoName in: path schema: type: string required: true description: '(Required) ' example: qui velit responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/photos/queue: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > photos summary: queue Photo Status description: Check the queue of photos security: - oauth2Auth: [] parameters: - name: url in: query schema: type: string example: qui velit - name: id in: query schema: type: number example: '-22637726' - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: productId in: path schema: type: number required: true description: (Required) The ID of the room or rate example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/amenities: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > amenities summary: list Room Amenities description: Retreive all the amenities of the listing security: - oauth2Auth: [] parameters: - name: portal in: query schema: type: string example: CTRIP - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '16997' - name: productId in: path schema: type: string required: true description: '(Required) ' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} > amenities summary: add Room Amenity description: Add an amenity for all portals requestBody: content: {} security: - oauth2Auth: [] parameters: - name: amenity in: query schema: type: string description: 'Amenity (Repetable) ' example: id irure ve - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: qui velit - name: productId in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/products/{accommodation}/{productId}/push/{portalname}: post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} summary: push Room Portal description: Push the room/rate to the portal specified requestBody: content: {} security: - bearerAuth: [] parameters: - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '450242' - name: productId in: path schema: type: integer required: true description: '(Required) ' example: '485655' - name: portalname in: path schema: type: string required: true description: '(Required) ' example: airbnb_xml responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/content/products/{accommodation}/{productId}/cancellation: post: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} summary: set Room Cancellation description: >- Set the cancellation policy for a specified PORTAL. To chose the right value, please refer to Metas Collection requestBody: content: {} security: - oauth2Auth: [] parameters: - name: value in: query schema: type: string example: FullCostOfStay - name: portal in: query schema: type: string example: expedia - name: accommodation in: path schema: type: integer required: true description: (Required) The ID of the accommodation example: '681002' - name: productId in: path schema: type: integer required: true description: (Required) The ID of the room or rate example: '225214' responses: '200': description: OK headers: X-RateLimit-Remaining: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '401': description: Unauthorized headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '500': description: Internal Server Error headers: X-RateLimit-Remaining: schema: type: string example: '' request-id: schema: type: string example: '' Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/content/products/{accommodation}/process/{processId}: get: tags: - >- rest/v1 > Each User One Login > content > products/{accommodation}/{product Id} summary: Read Request Status parameters: - name: accommodation in: path schema: type: integer required: true example: '9912119560' - name: processId in: path schema: type: integer required: true example: '1332' responses: '200': description: Successful response content: application/json: {} /rest/v1/checkin/{accommodation}/{reservationId}/guest/{guestId}: put: tags: - >- rest/v1 > Each User One Login > checkin/{accommodation} > {reservation Id} > guest/{guest Id} summary: update Guest description: >- Update an existing guest inside the reservation. Guest here is the detailed information retrieved during the checkin and usually send to police requestBody: content: '*/*': schema: type: string example: >- "{\n \"checkin\": \"1977-11-26\",\n \"checkout\": \"1972-01-04\",\n \"familyName\": \"Rossi\",\n \"givenName\": \"Mario\",\n \"type\": \"BOOKER\",\n \"id\": 123123,\n \"accommodatedType\": \"The first one will be automatically set as head of family, the others as relatives if null\",\n \"birthDate\": \"2015-11-05\",\n \"birthCountry\": \"IT\",\n \"birthCity\": \"ROMA\",\n \"residenceCountry\": \"IT\",\n \"city\": \"Roma\",\n \"email\": \"myname@mycompany.com\",\n \"phone\": \"minim tempor\",\n \"address\": \"15th Street, Manhattan, New York\",\n \"zipCode\": \"00022\",\n \"language\": \"IT\",\n \"nationality\": \"IT\",\n \"documentCode\": \"AS3332DC\",\n \"documentType\": \"Passport\",\n \"documentIssueDate\": \"1971-02-18\",\n \"documentIssuePlace\": \"Roma\",\n \"documentExpire\": \"1963-11-29T08:10:28.003Z\",\n \"sex\": \"MALE\"\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: string required: true description: (Required) Property ID (Octorate ID) example: qui velit - name: reservationId in: path schema: type: number required: true description: (Required) Reservation ID (Octorate ID) where update guests example: '-22637726' - name: guestId in: path schema: type: number required: true description: >- (Required) Guest ID. The id obtained from the GET reservation call OR the guest id example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: checkin: '1971-06-08' checkout: '2014-06-29' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1998-01-26' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: la address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1985-10-12' documentIssuePlace: Roma documentExpire: '1971-11-27T20:55:54.781Z' sex: MALE delete: tags: - >- rest/v1 > Each User One Login > checkin/{accommodation} > {reservation Id} > guest/{guest Id} summary: delete Guest description: Delete a guest of the reservation parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Property ID (Octorate ID) example: qui velit - name: reservationId in: path schema: type: number required: true description: (Required) Reservation ID (Octorate ID) where update guests example: '-22637726' - name: guestId in: path schema: type: number required: true description: >- (Required) Guest ID. The id obtained from the GET reservation call OR the guest id example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: checkin: '1971-06-08' checkout: '2014-06-29' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1998-01-26' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: la address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1985-10-12' documentIssuePlace: Roma documentExpire: '1971-11-27T20:55:54.781Z' sex: MALE /rest/v1/checkin/{accommodation}/{reservationId}: put: tags: - >- rest/v1 > Each User One Login > checkin/{accommodation} > {reservation Id} summary: Checkin/out Status description: >- Update the general status of the reservation as checked in, checked out or no show. requestBody: content: {} parameters: - name: status in: query schema: type: string example: CHECKOUT_END - name: accommodation in: path schema: type: string required: true description: (Required) Property ID (Octorate ID) example: qui velit - name: reservationId in: path schema: type: number required: true description: (Required) Reservation ID (Octorate ID) where update guests example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/checkin/{accommodation}/{id}/guest: post: tags: - rest/v1 > Each User One Login > checkin/{accommodation} summary: create Guest description: >- Create a new Guest inside the reservation. Guest here is the detailed information retrieved during the checkin and usually send to police requestBody: content: '*/*': schema: type: string example: >- "{\n \"checkin\": \"1977-11-26\",\n \"checkout\": \"1972-01-04\",\n \"familyName\": \"Rossi\",\n \"givenName\": \"Mario\",\n \"type\": \"GUEST\",\n \"accommodatedType\": null,\n \"birthCountry\": \"IT\",\n \"birthCity\": \"PADOVA\",\n \"residenceCountry\": \"IT\",\n \"city\": \"PADOVA\",\n \"email\": \"Van@octorate.com\",\n \"phone\": \"minim tempor\",\n \"address\": \"15th Street, Manhattan, New York\",\n \"zipCode\": \"00022\",\n \"language\": \"IT\",\n \"nationality\": \"IT\",\n \"documentCode\": \"AS3332DC\",\n \"documentType\": \"Passport\",\n \"documentIssueDate\": \"1971-02-18\",\n \"documentIssuePlace\": \"Roma\",\n \"documentExpire\": \"1963-11-29T08:10:28\",\n \"sex\": \"MALE\"\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: (Required) Property ID (Octorate ID) example: '656558' - name: id in: path schema: type: integer required: true description: (Required) Reservation ID (Octorate ID) example: '95357559' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: checkin: '1971-06-08' checkout: '2014-06-29' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1998-01-26' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: la address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1985-10-12' documentIssuePlace: Roma documentExpire: '1971-11-27T20:55:54.781Z' sex: MALE /connect/rest/v1/calendar/{accommodation}: get: tags: - rest/v1 > Each User One Login > calendar > {accommodation} summary: read Calendar description: Read the calendar data parameters: - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '500104' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - id: 253166 name: Camera singola Derived days: - availability: 1 bookable: true closeToArrival: false closeToDeparture: false cutOffDays: 0 date: '2020-04-01T00:00:00.000Z' maxStay: 99 minStay: 2 price: 39 stopSells: false /rest/v1/calendar/{accommodation}/{productId}/availabilityCheck: get: tags: - rest/v1 > Each User One Login > calendar > {accommodation} summary: Availability Check description: >- Perform a check for availability on Octorate Platform. The response is based on all the preference of the accommodation for the booking engine parameters: - name: startDate in: query schema: type: string example: '1969-10-26' - name: endDate in: query schema: type: string example: '1969-10-26' - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: qui velit - name: productId in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '406': description: Not Acceptable headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/calendar/bulk: post: tags: - rest/v1 > Each User One Login > calendar summary: Update Calendar (ARI) test description: >- Update the calendar values for the given rooms and date intervals. It takes in input a list requestBody: content: '*/*': schema: type: string example: >- "[\n {\n \"dateFrom\": \"2021-11-01\",\n \"dateTo\": \"2021-11-02\",\n \"room\": 394537,\n \"values\": {\n \"availability\": 1,\n \"closeToArrival\": false,\n \"closeToDeparture\": false,\n \"cutOffDays\": 0,\n \"empty\": false,\n \"maxstay\": 999,\n \"minstay\": 2,\n \"price\": 112.00,\n \"stopSells\": false\n }\n }\n]" security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: '' in: query schema: type: string responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: success: true process: - 12345678 error: Room not found at index 0! /rest/v1/calendar/process/{id}: get: tags: - rest/v1 > Each User One Login > calendar summary: Retrieve calendar request description: Retrieve the calendar update request status by process Id. parameters: - name: id in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: error: Error loading process info! id: 123456 createTime: '1980-01-17T10:27:00.040Z' lastUpdate: '2018-04-20T18:43:10.588Z' room: 12345 dateFrom: '1966-12-17' dateTo: '1959-10-09' status: NEW values: availability: -85942391 price: -85578326.4924311 minstay: -48815180 maxstay: 89600617 stopSells: false closeToArrival: false closeToDeparture: false cutOffDays: -88242703 sent: - date: '1974-10-30' status: NOT_PROCESSED values: availability: -5462406 price: 7855981.521250978 minstay: -36699956 maxstay: -53187577 stopSells: false closeToArrival: false closeToDeparture: false cutOffDays: 8050430 siteId: 123456 - date: '1967-04-23' status: ERROR values: availability: -67370644 price: -86226737.91236237 minstay: -28744044 maxstay: 60708959 stopSells: false closeToArrival: true closeToDeparture: false cutOffDays: -75434132 siteId: 123456 /connect/rest/v1/calendar/failures: get: tags: - rest/v1 > Each User One Login > calendar summary: Recent Failures responses: '200': description: Successful response content: application/json: {} /rest/v1/accommodation/network/{network}: get: tags: - rest/v1 > Each User One Login > accommodation > network > {network} summary: retrieve Network description: Retrieve a collection of properties that belongs to the same group security: - bearerAuth: [] parameters: - name: network in: path schema: type: string required: true description: '(Required) ' example: qui velit responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' post: tags: - rest/v1 > Each User One Login > accommodation > network > {network} summary: add To Network description: Add the accommodation provided to an existing network requestBody: content: {} security: - apikeyAuth: [] parameters: - name: accommodation in: query schema: type: string example: id irure ve - name: network in: path schema: type: string required: true description: '(Required) ' example: qui velit responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /connect/rest/v1/accommodation/network: get: tags: - rest/v1 > Each User One Login > accommodation > network > {network} summary: retrieve Network By current accommodation description: Retrieve a collection of properties that belongs to the same group security: - bearerAuth: [] parameters: - name: accommodationId in: query schema: type: integer example: '119947' - name: fields in: query schema: type: string example: id,name,licenseVersionMask responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/accommodation/network: post: tags: - rest/v1 > Each User One Login > accommodation > network summary: create Network description: Create a new network of accommodations requestBody: content: {} security: - bearerAuth: [] parameters: - name: accommodation in: query schema: type: integer example: '142322' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /connect/rest/v1/accommodation/{accommodation}/photos: get: tags: - >- rest/v1 > Each User One Login > accommodation > {accommodation} > photos summary: get Photos description: Retrieve photos parameters: - name: accommodation in: path schema: type: integer required: true description: (Required) The ID of the accommodation example: '880331' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' post: tags: - >- rest/v1 > Each User One Login > accommodation > {accommodation} > photos summary: push Photos description: Push a PHOTO to the property requestBody: content: {} parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded - name: url in: query schema: type: string description: >- URL to fetch to retrieve the photo (You can use query or form param as you prefer) example: >- https://hips.hearstapps.com/hmg-prod/images/beautiful-smooth-haired-red-cat-lies-on-the-sofa-royalty-free-image-1678488026.jpg - name: accommodation in: path schema: type: integer required: true description: (Required) The accommodation codice example: '880331' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/accommodation/{accommodation}/photos/{name}: delete: tags: - >- rest/v1 > Each User One Login > accommodation > {accommodation} > photos summary: delete Photo description: Delete a photo of the property parameters: - name: accommodation in: path schema: type: string required: true description: (Required) The ID of the accommodation example: qui velit - name: name in: path schema: type: string required: true description: (Required) Previously retrieved photo name example: qui velit responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /connect/rest/v1/accommodation/{accommodation}/queue: get: tags: - >- rest/v1 > Each User One Login > accommodation > {accommodation} > queue summary: queue Accommodation description: Check the photo upload queue parameters: - name: accommodation in: path schema: type: integer required: true description: (Required) Accommodation example: '880331' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/accommodation/{accommodation}/queue/{id}: get: tags: - >- rest/v1 > Each User One Login > accommodation > {accommodation} > queue summary: retrieve Task description: Check on the queue the status of the task provided parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Accommodation example: qui velit - name: id in: path schema: type: number required: true description: (Required) Id/Token of the photo to check example: '-22637726' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /connect/rest/v1/accommodation/{accommodation}: get: tags: - rest/v1 > Each User One Login > accommodation > {accommodation} summary: retrieve Accommodation parameters: - name: fields in: query schema: type: string example: id,name,licenseVersionMask - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '16997' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: ex qui enim id: labore anim dstsavings: -61868972 rawOffset: 67448497 phoneNumber: proident ipsum occaecat Duis address: 'pariatur ' latitude: -41095261.30711552 longitude: -68982685.08739713 zipCode: deserunt fugiat in city: nostrud cillum propertyCategory: FARMHOUSE location: id: 95877904 placeType: ROOM address: ad officia aute proident city: dolor proident Ut dolor nulla zipCode: laboris laborum country: PR phone: et incididunt id latitude: 19702765.517493814 longitude: 82059486.22827056 zoom: 52213434 codice: irure elit anim districtName: velit Excepteur eiusmod networkActive: true networkInfo: accessNetwork: ullamco laboris et culpa accessRoot: true accessEnabled: true contact: contactName: aliqua pariatur dolore phoneNumber: laborum mobilePrefix: dolor pariatur dolor mobileNumber: '' email: labore givenName: ut familyName: sint in license: channelManager: PREMIUM bookingEngine: true octoSite: true realPlanning: false webConcierge: false chat: false smartOffer: true octoDaily: true metaSearch: false rms: false fiscalPrinter: true expireDay: '1991-12-18T02:09:11.103Z' patch: tags: - rest/v1 > Each User One Login > accommodation > {accommodation} summary: update Accommodation description: Update an existing accommodation requestBody: content: '*/*': schema: type: string example: >- "{\n \"accept_duplicates\": false,\n \"companyType\": \"COMPANY\",\n \"license\": {\n \"expireDay\": \"2022-12-31T23:00:00Z[UTC]\"\n },\n \"referral_text\": true,\n \"timeZone\": \"Europe/Rome\",\n \"welcome_user\": true\n}" security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: (Required) Accommodation id, should be part of your network example: '496396' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: ex qui enim id: labore anim dstsavings: -61868972 rawOffset: 67448497 phoneNumber: proident ipsum occaecat Duis address: 'pariatur ' latitude: -41095261.30711552 longitude: -68982685.08739713 zipCode: deserunt fugiat in city: nostrud cillum propertyCategory: FARMHOUSE location: id: 95877904 placeType: ROOM address: ad officia aute proident city: dolor proident Ut dolor nulla zipCode: laboris laborum country: PR phone: et incididunt id latitude: 19702765.517493814 longitude: 82059486.22827056 zoom: 52213434 codice: irure elit anim districtName: velit Excepteur eiusmod networkActive: true networkInfo: accessNetwork: ullamco laboris et culpa accessRoot: true accessEnabled: true contact: contactName: aliqua pariatur dolore phoneNumber: laborum mobilePrefix: dolor pariatur dolor mobileNumber: '' email: labore givenName: ut familyName: sint in license: channelManager: PREMIUM bookingEngine: true octoSite: true realPlanning: false webConcierge: false chat: false smartOffer: true octoDaily: true metaSearch: false rms: false fiscalPrinter: true expireDay: '1991-12-18T02:09:11.103Z' '304': description: Not Modified headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/accommodation/{accommodation}: delete: tags: - rest/v1 > Each User One Login > accommodation > {accommodation} summary: delete Accommodation description: Delete the specified property security: - apikeyAuth: [] parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Accommodation Id example: qui velit responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: ex qui enim id: labore anim dstsavings: -61868972 rawOffset: 67448497 phoneNumber: proident ipsum occaecat Duis address: 'pariatur ' latitude: -41095261.30711552 longitude: -68982685.08739713 zipCode: deserunt fugiat in city: nostrud cillum propertyCategory: FARMHOUSE location: id: 95877904 placeType: ROOM address: ad officia aute proident city: dolor proident Ut dolor nulla zipCode: laboris laborum country: PR phone: et incididunt id latitude: 19702765.517493814 longitude: 82059486.22827056 zoom: 52213434 codice: irure elit anim districtName: velit Excepteur eiusmod networkActive: true networkInfo: accessNetwork: ullamco laboris et culpa accessRoot: true accessEnabled: true contact: contactName: aliqua pariatur dolore phoneNumber: laborum mobilePrefix: dolor pariatur dolor mobileNumber: '' email: labore givenName: ut familyName: sint in license: channelManager: PREMIUM bookingEngine: true octoSite: true realPlanning: false webConcierge: false chat: false smartOffer: true octoDaily: true metaSearch: false rms: false fiscalPrinter: true expireDay: '1991-12-18T02:09:11.103Z' /connect/rest/v1/accommodation: get: tags: - rest/v1 > Each User One Login > accommodation summary: retrieve Accommodations description: >- Find accommodations created or attached. Response will vary according to the security provided (All the properties with ApiOperations, Only token properties with OAuthLogin) parameters: - name: fields in: query schema: type: string example: all responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - currency: EUR id: '47260' name: Silvia Test Api Master timeZone: Europe/Rome contact: email: tech@dormoa.com familyName: Silvia givenName: Silvia mobileNumber: '' mobilePrefix: 39 location: city: Roma country: IT districtName: '' latitude: 0 longitude: 0 zipCode: '' zoom: 13 networkActive: true networkInfo: accessEnabled: true accessNetwork: '314142' accessRoot: true propertyCategory: OTHER - currency: EUR id: '314142' name: Silvia Test Api timeZone: Europe/Rome contact: email: tech@dormoa.com familyName: Silvia givenName: Silvia mobileNumber: '' mobilePrefix: 39 location: city: Roma country: IT districtName: '' latitude: 0 longitude: 0 zipCode: '' zoom: 13 networkActive: true networkInfo: accessEnabled: true accessNetwork: '314142' accessRoot: false propertyCategory: OTHER - currency: EUR id: '450020' name: Silvia Test Api Account 2 timeZone: Europe/Rome contact: email: tech@dormoa.com familyName: Silvia givenName: Silvia mobileNumber: '' mobilePrefix: 39 location: city: Roma country: IT districtName: '' latitude: 0 longitude: 0 zipCode: '' zoom: 13 networkActive: true networkInfo: accessEnabled: true accessNetwork: '314142' accessRoot: false propertyCategory: OTHER post: tags: - rest/v1 > Each User One Login > accommodation summary: create Accommodation Temp requestBody: content: '*/*': schema: type: string example: >- "{\n \"cod_promo\": \"openlab\",\n \"name\": \"Agriturismo Tibitone\",\n \"accept_duplicates\": true,\n \"welcome_user\": false,\n \"welcome_alternative_email\": \"devin@octorate.com\",\n \"givenName\": \"Marco\",\n \"familyName\": \"Coricciati\",\n \"currency\": \"EUR\",\n \"timeZone\": \"Europe/Rome\",\n \"companyType\": \"PRIVATE_PERSON\",\n \"email\": \"test@test.com\",\n \"address\": \"Strada Provinciale 26\",\n \"postcode\": \"72021\",\n \"zip\": \"72021\",\n \"city\": \"Francavilla Fontana\",\n \"country\": \"IT\",\n \"referral_text\": false,\n \"latitude\": 40.5408,\n \"longitude\": 17.5776,\n \"license\":{\n \"partnerVersionCode\":3\n }\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: status: CREATED_ACCOMMODATION id: '16997' refresh_token: longcodedsadasdasda '412': description: Precondition Failed headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/extra/{accommodation}: get: tags: - rest/v1 > Each User One Login > extra/{accommodation} summary: find Extras description: Retrieve all the existing extras products parameters: - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '16997' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: data: - id: 200043 name: IVA accommodation: currency: EUR id: '112696' name: La Pergola di Venezia timeZone: Europe/Rome enabled: true mandatory: false refundable: false basePrice: 0 description: {} model: BOOKING taxPercent: 0 title: {} - id: 200044 name: Tassa di soggiorno accommodation: currency: EUR id: '112696' name: La Pergola di Venezia timeZone: Europe/Rome enabled: true mandatory: false refundable: false basePrice: 0 description: {} model: BOOKING taxPercent: 0 title: {} post: tags: - rest/v1 > Each User One Login > extra/{accommodation} summary: create Extra Product description: Create new Extra Product requestBody: content: application/json: schema: type: object example: data: - model: WEEK name: dolor m accommodation: '16997' enabled: false mandatory: false refundable: false category: DRINKS basePrice: 20 taxPercent: 10 description: EN: These are the LanguageMap value in English! title: EN: These are the LanguageMap value in English! parameters: - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '16997' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: model: WEEK name: dolor ex dolor m id: 12322 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: anim ea id: sed ut dstsavings: 27655032 rawOffset: -69695280 phoneNumber: 'elit ea Duis reprehenderit ' address: amet nostrud non Ut latitude: 55317135.96259385 longitude: -85894895.09917381 zipCode: esse laborum velit et laboris city: deserunt enabled: false mandatory: false refundable: false basePrice: 0 taxPercent: 0 description: EN: These are the LanguageMap value in English! title: EN: These are the LanguageMap value in English! /connect/rest/v1/extra/bulk/{accommodation}: post: tags: - rest/v1 > Each User One Login > extra/{accommodation} summary: create Extra Product Bulk description: Create new Extra Product requestBody: content: application/json: schema: type: object example: data: - taxPercent: 10 enabled: true basePrice: 10 name: Example Extra model: BOOKING security: - bearerAuth: [] parameters: - name: accommodation in: path schema: type: integer required: true example: '466761' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: model: WEEK name: dolor ex dolor m id: 12322 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: anim ea id: sed ut dstsavings: 27655032 rawOffset: -69695280 phoneNumber: 'elit ea Duis reprehenderit ' address: amet nostrud non Ut latitude: 55317135.96259385 longitude: -85894895.09917381 zipCode: esse laborum velit et laboris city: deserunt enabled: false mandatory: false refundable: false basePrice: 0 taxPercent: 0 description: EN: These are the LanguageMap value in English! title: EN: These are the LanguageMap value in English! /rest/v1/extra/{accommodation}/{productId}: put: tags: - rest/v1 > Each User One Login > extra/{accommodation} summary: Update a product description: >- Update a product inside Octorate. You can set as active or not a product here requestBody: content: {} parameters: - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: qui velit - name: productId in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' '304': description: Not Modified headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/user/person: get: tags: - rest/v1 > Each User One Login > chat summary: Retrieve Person responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/chat/messages: post: tags: - rest/v1 > Each User One Login > chat summary: Search Message requestBody: content: application/json: schema: type: object example: externalThreadId: ae88b8d940a74d0da6ae26f7245e91de responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/chat/{property}/messages: get: tags: - rest/v1 > Each User One Login > chat summary: Search Message Query parameters: - name: queryString in: query schema: type: string example: scu - name: property in: path schema: type: integer required: true example: '681002' responses: '200': description: Successful response content: application/json: {} post: tags: - rest/v1 > Each User One Login > chat summary: Create New Message requestBody: content: application/json: schema: type: object example: processor: CHANNEL threadId: 5809626 status: CREATED createTime: '2024-01-23T11:15:08+00:00' attributes: - type: TEXT value: >- 👋 Dear Eva, 📆 Your arrival at Appartamento con terrazza vista Vaticano on 26/01/2024 is just around the corner, and we are excited to welcome you. 📘 To help you prepare for your stay, we have compiled a special guide just for you: ➡️🌍 Rome Guide: Discover the secrets of Rome with our exclusive guide. You'll find useful tips on where to eat, what to see, and how to get around the city. Guide Link: https://1drv.ms/b/s!AgdPAjkBbfdviLwnsWVAKm5htqnikA?e=0n15lT ➡️🏠 House Guide: Our house guide will provide you with all the necessary information to make the most of your stay, including practical advice and house rules. Guide Link: https://customers.bookpage.io/portal/guestbook?property_id=140113 💬 If you have any questions or need further information before your arrival, please do not hesitate to contact us. Our goal is to make your stay as pleasant and comfortable as possible. 🙏 We thank you again for completing the online check-in and look forward to seeing you soon! 🖊️ Warm regards, Giulia Zimei, LaMiaCasaVacanze.com 393385213943 ericmont.cav@gmail.com - type: OTA_FLOW_DIRECTION value: TO parameters: - name: property in: path schema: type: integer required: true example: '804245' responses: '403': description: Forbidden headers: Content-Encoding: schema: type: string example: gzip Server: schema: type: string example: 'Payara Server 6.2023.12 #badassfish' X-Powered-By: schema: type: string example: >- Servlet/6.0 JSP/3.1 (Payara Server 6.2023.12 #badassfish Java/Ubuntu/11) Access-Control-Allow-Origin: schema: type: string example: http://localhost:4200 Access-Control-Allow-Methods: schema: type: string example: PATCH, PUT, DELETE Access-Control-Allow-Headers: schema: type: string example: Origin, X-Requested-With, Content-Type, Accept, Authorization Access-Control-Allow-Credentials: schema: type: boolean example: 'true' Content-Security-Policy: schema: type: string example: frame-ancestors http://localhost:4200 http://localhost:8080 request-id: schema: type: string example: 84c7e246-93d7-4b74-a87c-d92ba6991fff X-RateLimit-Remaining: schema: type: integer example: '296' X-RateLimit-Remaining-681002: schema: type: integer example: '88' Content-Language: schema: type: string example: '' Content-Type: schema: type: string example: text/html Transfer-Encoding: schema: type: string example: chunked X-Frame-Options: schema: type: string example: SAMEORIGIN content: text/plain: schema: type: string example: >- Payara Server 6.2023.12 #badassfish - Error report

HTTP Status 403 - Forbidden

type Status report

messageForbidden

descriptionAccess to the specified resource has been forbidden.

Payara Server 6.2023.12 #badassfish

/rest/v1/chat/{property}/threads: post: tags: - rest/v1 > Each User One Login > chat summary: Create Thread requestBody: content: application/json: schema: type: object example: firstName: devin phone: '+393347608861' parameters: - name: channel in: query schema: type: string example: whatsapp_message_bird - name: processor in: query schema: type: string example: WHATSAPP - name: externalThread in: query schema: type: string example: e5f8e6b3963d4dbfa2c99562d036c791 - name: property in: path schema: type: integer required: true example: '681002' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/chat/{property}/messages/{mexId}: put: tags: - rest/v1 > Each User One Login > chat summary: Update Message requestBody: content: application/json: schema: type: object example: externalId: 38ecb3a6931542e4b8e51be1350c44bd refer: null externalThreadId: e5f8e6b3963d4dbfa2c99562d036c791 attributes: - id: 3323623 messageId: 1975624 type: LANGUAGE value: en - id: 3323624 messageId: 1975624 type: MOBILE_PHONE value: '+393347608861' - id: 3323621 messageId: 1975624 type: MAIL_TEMPLATE_ID value: '32806' - id: 3323622 messageId: 1975624 type: TEXT value: '1 Devin1522 template ID #32806 - conferma una prenotazione' - id: 3323625 messageId: 1975624 type: LANGUAGE value: en - id: 3323635 messageId: 1975624 type: OTA_FLOW_DIRECTION value: FROM - id: null messageId: null type: MESSAGES_LABEL_NAME value: chatMessageTemplateAuth id: 1970263 threadId: 434434 processor: WHATSAPP readers: - id: 2520512 messageId: 1970263 readTime: '2022-07-28T11:22:46+00:00' reader: email: devin.octorate@gmail.com firstname: Devin1522 fullname: Taietta Devin1522 guestId: 1815687 id: 445176 lastname: Taietta phone: +39 334 760 8861 sentTime: null createTime: null status: SENT hotelId: null sender: email: server@octorate.com firstname: Octorate fullname: Channel Manager Octorate id: 13 lastname: Channel Manager userId: 1 username: octocm source: PHP-REPLY-PUT parameters: - name: property in: path schema: type: integer required: true example: '681002' - name: mexId in: path schema: type: integer required: true example: '1970263' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/chat/{property}/threads/{threadId}/messages: get: tags: - rest/v1 > Each User One Login > chat summary: Message of the Thread parameters: - name: fields in: query schema: type: string example: id,status,createTime, attributes - name: limitTime in: query schema: type: string example: '2022-07-24T00:00:00.000Z' - name: property in: path schema: type: integer required: true example: '681002' - name: threadId in: path schema: type: integer required: true example: '371010' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/chat/16997/unreadedMessagesCount: get: tags: - rest/v1 > Each User One Login > chat summary: Count Mexs security: - bearerAuth: [] responses: '200': description: Successful response content: application/json: {} /rest/v1/reservation/{accommodation}/{id}/extra/{extraId}: put: tags: - >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > extra > {extra Id} summary: update Extra Reservation description: Update an existing reservation requestBody: content: '*/*': schema: type: string example: >- "{\n \"product\": 12312,\n \"price\": 12.22,\n \"quantity\": 1,\n \"day\": \"2000-05-17\",\n \"url\": \"eiusmod amet velit\"\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: (Required) Property ID (Octorate ID) example: '16997' - name: id in: path schema: type: integer required: true description: (Required) Reservation ID (Octorate ID) example: '94805860' - name: extraId in: path schema: type: integer required: true description: '(Required) ' example: '1151191' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: product: 12312 id: 12312 price: 12.22 quantity: 1 day: '2017-12-26' url: sit delete: tags: - >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > extra > {extra Id} summary: delete Extra Reservation description: Delete an extra of reservation given parameters: - name: accommodation in: path schema: type: string required: true description: (Required) Property code (ID) example: qui velit - name: id in: path schema: type: number required: true description: (Required) Reservation ID (Octorate ID) example: '-22637726' - name: extraId in: path schema: type: number required: true description: (Required) Id of the extra example: '-22637726' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: product: 12312 id: 12312 price: 12.22 quantity: 1 day: '2017-12-26' url: sit /connect/rest/v1/reservation/{accommodation}/{id}/extra: post: tags: - >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > extra summary: add Extra Reservation description: Update an existing reservation requestBody: content: '*/*': schema: type: string example: >- "{\n \"product\": 515049,\n \"price\": null,\n \"quantity\": 2\n}" security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: (Required) Property ID (Octorate ID) example: '16997' - name: id in: path schema: type: integer required: true description: (Required) Reservation ID (Octorate ID) example: '94744650' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /connect/rest/v1/reservation/{accommodation}/{id}/extras: post: tags: - >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > extra summary: add many Extra Reservation description: Update an existing reservation requestBody: content: '*/*': schema: type: string example: >- "{\n \"extras\": [\n {\n \"product\": 196998,\n \"quantity\": 3\n },\n {\n \"product\": 196998,\n \"quantity\": 7\n }\n ]\n}" security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: (Required) Property ID (Octorate ID) example: '16997' - name: id in: path schema: type: integer required: true description: (Required) Reservation ID (Octorate ID) example: '95850871' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /connect/rest/v1/reservation/{accommodation}/{id}/payment: post: tags: - >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > payment summary: Create Payment requestBody: content: application/json: schema: type: object example: referenceTime: '2019-08-24T14:15:22Z' description: Test Payment paymentMode: CREDITCARD amount: 10 parameters: - name: accommodation in: path schema: type: integer required: true example: '681002' - name: id in: path schema: type: integer required: true example: '93592615' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/reservation/{accommodation}/{id}/payment/{paymentId}: put: tags: - >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > payment summary: Update Payment requestBody: content: application/json: schema: type: object example: referenceTime: '2019-08-24T14:15:22Z' description: Test Payment 2 paymentMode: CASH amount: 11 parameters: - name: accommodation in: path schema: type: integer required: true example: '681002' - name: id in: path schema: type: integer required: true example: '93592615' - name: paymentId in: path schema: type: integer required: true example: '3675455' responses: '200': description: Successful response content: application/json: {} delete: tags: - >- rest/v1 > Each User One Login > reservation > {accommodation} > {id} > payment summary: Delete Payment parameters: - name: accommodation in: path schema: type: integer required: true example: '681002' - name: id in: path schema: type: integer required: true example: '93592615' - name: paymentId in: path schema: type: integer required: true example: '3675454' responses: '200': description: Successful response content: application/json: {} /rest/v1/reservation/{accommodation}/{id}: get: tags: - rest/v1 > Each User One Login > reservation > {accommodation} > {id} summary: find Reservation description: Retrieve an existing reservation security: - bearerAuth: [] parameters: - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '16997' - name: id in: path schema: type: integer required: true description: '(Required) ' example: '94744650' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 212 checkin: '1998-04-07T13:19:31.533Z' checkout: '1986-01-21T01:33:30.129Z' createTime: '1956-05-30T19:21:31.379Z' guests: - checkin: '1980-06-26' checkout: '1986-12-12' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1947-06-11' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: eiusmod enim address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1963-09-26' documentIssuePlace: Roma documentExpire: '2002-12-15T00:00:44.402Z' sex: MALE - checkin: '1972-02-06' checkout: '1975-07-05' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1943-06-02' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: et labor address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '2020-02-24' documentIssuePlace: Roma documentExpire: '1984-01-30T01:04:30.106Z' sex: MALE product: 1222222 refer: A2DD123_AA2211 status: CONFIRMED totalChildren: 0 totalGuest: 0 totalInfants: 0 updateTime: '1961-09-12T02:17:49.980Z' channelRefer: A12FF232DDDDDD pmsProduct: 1200122 roomGross: 47.56 channelNotes: Reservation payment facilitated through a virtual card privateNotes: >- Customer says is not sure whether will arrive on 25th or 26th of March, Payment was agreed but not yet arrived priceBreakdown: - type: DAILY_ROOM_PRICE createTime: '2008-04-10T07:00:33.394Z' day: '1996-12-30' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 33944167 included: false - type: DAILY_ROOM_PRICE createTime: '2001-11-07T19:07:43.396Z' day: '1958-11-09' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 10624519 included: true id: 123123 channelName: BOOKING currency: currencyCode: fugiat ut ut quis defaultFractionDigits: -73482270 numericCode: -26403502 displayName: Ut eiusmod irure symbol: elit commodo anim numericCodeAsString: exercitation touristTax: 12 paymentType: CREDITCARD paymentStatus: UNPAID freeCancellation: false paidCancellation: '2003-05-06T23:34:38.675Z' creditCard: token: a2uuy-uuyte-76433-hyt453-kkssst bank: ING DIRECT Bv. bankCountry: IT scheme: MASTERCARD activationDate: '2013-06-28T12:25:45.220Z' expireDate: '1994-04-08T13:27:52.576Z' lastUpdate: '2005-08-12T16:18:41.416Z' cvvAvailable: false cvvCleared: false cardUsed: false cardVirtual: true payments: - id: -56127074 insertTime: '1955-08-26T11:00:34.042Z' referenceTime: '1963-02-03T12:56:15.924Z' description: nulla aliquip paymentMode: CREDITCARD amount: -12937365.574373677 cityTaxAmount: 17884334.010387942 user: id: -135282 username: tempor ullamco in culpa firstname: ad in aliquip magna codpromo: labore ut ipsum codice: laborum sint quis deserunt labore type: USER scheduled: true scheduledTime: '1953-02-07T05:57:53.606Z' scheduledAmount: -92036134.19708799 - id: -46277909 insertTime: '1978-11-07T14:46:55.618Z' referenceTime: '2015-02-26T14:24:40.786Z' description: irure cupidatat fugiat paymentMode: CREDITCARD amount: 87324688.30332795 cityTaxAmount: -4032361.6976282448 user: id: 94851837 username: Lorem anim elit velit firstname: Ut ut codpromo: pariatur elit codice: cupidatat dolore type: ADMIN scheduled: false scheduledTime: '1969-08-14T10:08:15.275Z' scheduledAmount: -15304188.207770735 linkedReservations: - -57192556 - 75587101 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: aliqua eiusmod anim minim id: sit dstsavings: -70417523 rawOffset: 85525228 phoneNumber: Excepteur sed Ut aute dolor address: laboris adipisicing minim latitude: -82631170.96219333 longitude: 6846293.061984941 zipCode: commodo aute city: ipsum roomName: ut occaecat do roomNameGuest: nostrud ipsum guestsList: est Ut guestMailAddress: ut arrivalTime: ex amet split: splitRoom: id: 36452220 name: enim proiden splitAccommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: cillum id: cillum ad elit dstsavings: -10397929 rawOffset: -35222741 phoneNumber: ut sed in address: ut dolore minim cillum amet latitude: -67882608.26251987 longitude: 52765133.69408736 zipCode: fugiat nisi city: nostrud connection: id: 50591996 name: ea laborum splitStart: '1999-10-14' address: est do amet country: magna qui labore consectetur guest: address: consectetur country: sunt conse email: dolor nostrud elit city: labore phone: Duis culpa irure enim zip: culpa magna firstName: non in est Lorem lastName: reprehenderit incididunt consectetur sint proident reservationExternal: id: 37860786 channelId: sint do magna propertyId: repreh octorateId: ullamco tempor sit room: aliqua externalRefer: id api: true totalPaid: 60482471.921477824 conversationId: officia Ut ad cleaningFee: -60828494.92426212 place: id: 88344960 placeType: ROOM address: elit Excepteur city: qui tempor adipisicing zipCode: nostrud dolore consequat country: WS phone: ad latitude: -18677000.514493212 longitude: -60626748.74683358 zoom: 49282517 codice: dolor ea est veniam districtName: dolor city: proident zip: dolor sit do adipisicing extra: - day: '1955-09-17' octorateProductId: 59709117 price: -58404383.18974792 quantity: -94253733 reference: amet veniam sunt et Excepteur - day: '2003-09-07' octorateProductId: -37370826 price: 10066153.04357244 quantity: 31624864 reference: consequat sit labore elit officia children: -7796201 related: - extra: - day: '1973-09-13' octorateProductId: 28331531 price: 52858371.05080637 quantity: -44566067 reference: aute consectetur - day: '1988-12-07' octorateProductId: 65427572 price: 53022363.759127915 quantity: 95529165 reference: nisi children: -10862486 currency: currencyCode: id incididunt do dolore defaultFractionDigits: 44461268 numericCode: -84010043 displayName: deserunt dolore ipsum symbol: quis laboris numericCodeAsString: dolore veniam velit lang: JA portalId: labori internalRoom: -10937429 totalGross: -77589449.00905812 roomGross: -91035079.61337897 guest: address: Duis amet incididunt Excepteur country: elit est do incididunt eu email: anim city: ullamco minim dolore labore phone: voluptate adipisicing in anim zip: aliquip Lorem cillum firstName: proident Lorem lastName: quis et officia laborum reservationExternal: id: -18605868 channelId: Ut propertyId: ex proident mollit octorateId: mollit sint room: id dolor in ipsum propertyReference: in culpa infants: 54018624 externalRefer: pariatur l createDate: '1967-06-23T18:06:50.312Z' updateDate: '1985-11-17T14:13:50.942Z' api: false externalRoom: i internalRate: -83066520 portalNotes: in nulla dolor velit qui pmsRoom: quis paidStayTax: 81928919.95935705 paidNotes: est veniam i totalPaid: -70440394.96344703 conversationId: veniam irure cleaningFee: -62981266.59294714 totalCommissions: -96155716.12793486 companyCollect: HOTEl daily: - day: '2001-12-30T19:12:53.424Z' price: 26212445.084135845 - day: '1942-12-06T15:16:53.752Z' price: -87651355.546878 streamCard: activationDate: '1969-11-25T05:42:33.110Z' expirationDate: '1969-03-06T16:05:29.718Z' currentBalance: 50793243.165685534 isVirtual: false token: et irure empty: false json: {} paymentMode: TRAVELCHEQUE place: id: 27356853 placeType: ACCOMODATION address: commodo pariatur exercitation irure city: comm zipCode: qui deserunt country: ZM phone: in aute latitude: 26976337.042860672 longitude: -20279923.244849667 zoom: -18267744 codice: esse ipsum qui commodo districtName: fugiat dolor esse startDate: '1943-04-14T06:36:33.971Z' specialRequests: dolore officia ipsum exer endDate: '2012-11-30T16:30:59.415Z' pax: 59957498 refer: sint status: CANCELLED - extra: - day: '2017-03-04' octorateProductId: 6479987 price: -94194397.02271108 quantity: 69901245 reference: irure - day: '1992-01-20' octorateProductId: -58629307 price: -92548047.06198661 quantity: 84320484 reference: dolore consequat children: -6561724 currency: currencyCode: est dolore defaultFractionDigits: 13218287 numericCode: -78551435 displayName: dolore sunt nisi in symbol: labori numericCodeAsString: occaecat consequat lang: DE portalId: cupidata internalRoom: 41439857 totalGross: -57802706.21854742 roomGross: 19181535.636508018 guest: address: ut country: consequat occaecat tempor laborum email: proident pariatur nulla incididunt exercitation city: ullamco phone: nulla do zip: sunt quis dolore firstName: laborum lastName: in dolore nisi magna mollit reservationExternal: id: -24164995 channelId: officia adipisicing ipsum commodo propertyId: enim in magna octorateId: ullamco consequat anim room: sit ullamco nostrud irure propertyReference: Excepteur dolore exercitation aliquip infants: 91678044 externalRefer: sunt anim createDate: '1947-01-31T10:37:58.713Z' updateDate: '1964-03-19T13:46:17.045Z' api: false externalRoom: eu do et dolore internalRate: -98171121 portalNotes: laboris ad ullamco pmsRoom: dolore nulla et ipsum paidStayTax: 57975318.35698146 paidNotes: fugi totalPaid: -96726514.79057235 conversationId: fugiat cleaningFee: 57742381.169671685 totalCommissions: -71702611.46805315 companyCollect: HOTEl daily: - day: '1986-07-26T20:04:11.861Z' price: 28002943.06947376 - day: '1945-12-10T09:37:52.129Z' price: 41149150.43056935 streamCard: activationDate: '1969-09-08T22:15:42.812Z' expirationDate: '1955-02-21T22:47:40.047Z' currentBalance: -8015570.095736146 isVirtual: false token: Excepteur sunt fugiat minim empty: false json: {} paymentMode: UNKNOWN place: id: -54651458 placeType: ROOM address: est non adipisicing ad city: commodo deserunt zipCode: ullamco nulla qui cupidatat country: NE phone: enim id sunt latitude: -37089003.877104074 longitude: -88204370.08191791 zoom: -78985514 codice: est nisi districtName: sunt velit nostrud quis deserunt startDate: '1965-12-26T17:18:20.032Z' specialRequests: esse exer endDate: '1958-05-13T19:31:34.180Z' pax: 12584432 refer: non in anim officia tempor status: WAITING propertyReference: cupidatat dolore dolor infants: 35070726 internalRate: -19028931 companyCollect: NONE daily: - day: '1952-02-29T13:00:18.718Z' price: -42433803.06861964 - day: '1962-06-21T10:47:12.556Z' price: 43265339.69111946 streamCard: activationDate: '1947-10-25T03:53:41.638Z' expirationDate: '2008-08-04T02:43:13.346Z' currentBalance: 76973254.82536885 isVirtual: false token: ut aliqua dolor empty: true json: {} paymentMode: CHEQUE delete: tags: - rest/v1 > Each User One Login > reservation > {accommodation} > {id} summary: delete Reservation description: >- Delete a reservation (This method can be used as alternative of update reservation to create a cancellation) parameters: - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: qui velit - name: id in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 212 checkin: '1998-04-07T13:19:31.533Z' checkout: '1986-01-21T01:33:30.129Z' createTime: '1956-05-30T19:21:31.379Z' guests: - checkin: '1980-06-26' checkout: '1986-12-12' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1947-06-11' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: eiusmod enim address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1963-09-26' documentIssuePlace: Roma documentExpire: '2002-12-15T00:00:44.402Z' sex: MALE - checkin: '1972-02-06' checkout: '1975-07-05' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1943-06-02' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: et labor address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '2020-02-24' documentIssuePlace: Roma documentExpire: '1984-01-30T01:04:30.106Z' sex: MALE product: 1222222 refer: A2DD123_AA2211 status: CONFIRMED totalChildren: 0 totalGuest: 0 totalInfants: 0 updateTime: '1961-09-12T02:17:49.980Z' channelRefer: A12FF232DDDDDD pmsProduct: 1200122 roomGross: 47.56 channelNotes: Reservation payment facilitated through a virtual card privateNotes: >- Customer says is not sure whether will arrive on 25th or 26th of March, Payment was agreed but not yet arrived priceBreakdown: - type: DAILY_ROOM_PRICE createTime: '2008-04-10T07:00:33.394Z' day: '1996-12-30' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 33944167 included: false - type: DAILY_ROOM_PRICE createTime: '2001-11-07T19:07:43.396Z' day: '1958-11-09' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 10624519 included: true id: 123123 channelName: BOOKING currency: currencyCode: fugiat ut ut quis defaultFractionDigits: -73482270 numericCode: -26403502 displayName: Ut eiusmod irure symbol: elit commodo anim numericCodeAsString: exercitation touristTax: 12 paymentType: CREDITCARD paymentStatus: UNPAID freeCancellation: false paidCancellation: '2003-05-06T23:34:38.675Z' creditCard: token: a2uuy-uuyte-76433-hyt453-kkssst bank: ING DIRECT Bv. bankCountry: IT scheme: MASTERCARD activationDate: '2013-06-28T12:25:45.220Z' expireDate: '1994-04-08T13:27:52.576Z' lastUpdate: '2005-08-12T16:18:41.416Z' cvvAvailable: false cvvCleared: false cardUsed: false cardVirtual: true payments: - id: -56127074 insertTime: '1955-08-26T11:00:34.042Z' referenceTime: '1963-02-03T12:56:15.924Z' description: nulla aliquip paymentMode: CREDITCARD amount: -12937365.574373677 cityTaxAmount: 17884334.010387942 user: id: -135282 username: tempor ullamco in culpa firstname: ad in aliquip magna codpromo: labore ut ipsum codice: laborum sint quis deserunt labore type: USER scheduled: true scheduledTime: '1953-02-07T05:57:53.606Z' scheduledAmount: -92036134.19708799 - id: -46277909 insertTime: '1978-11-07T14:46:55.618Z' referenceTime: '2015-02-26T14:24:40.786Z' description: irure cupidatat fugiat paymentMode: CREDITCARD amount: 87324688.30332795 cityTaxAmount: -4032361.6976282448 user: id: 94851837 username: Lorem anim elit velit firstname: Ut ut codpromo: pariatur elit codice: cupidatat dolore type: ADMIN scheduled: false scheduledTime: '1969-08-14T10:08:15.275Z' scheduledAmount: -15304188.207770735 linkedReservations: - -57192556 - 75587101 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: aliqua eiusmod anim minim id: sit dstsavings: -70417523 rawOffset: 85525228 phoneNumber: Excepteur sed Ut aute dolor address: laboris adipisicing minim latitude: -82631170.96219333 longitude: 6846293.061984941 zipCode: commodo aute city: ipsum roomName: ut occaecat do roomNameGuest: nostrud ipsum guestsList: est Ut guestMailAddress: ut arrivalTime: ex amet split: splitRoom: id: 36452220 name: enim proiden splitAccommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: cillum id: cillum ad elit dstsavings: -10397929 rawOffset: -35222741 phoneNumber: ut sed in address: ut dolore minim cillum amet latitude: -67882608.26251987 longitude: 52765133.69408736 zipCode: fugiat nisi city: nostrud connection: id: 50591996 name: ea laborum splitStart: '1999-10-14' address: est do amet country: magna qui labore consectetur guest: address: consectetur country: sunt conse email: dolor nostrud elit city: labore phone: Duis culpa irure enim zip: culpa magna firstName: non in est Lorem lastName: reprehenderit incididunt consectetur sint proident reservationExternal: id: 37860786 channelId: sint do magna propertyId: repreh octorateId: ullamco tempor sit room: aliqua externalRefer: id api: true totalPaid: 60482471.921477824 conversationId: officia Ut ad cleaningFee: -60828494.92426212 place: id: 88344960 placeType: ROOM address: elit Excepteur city: qui tempor adipisicing zipCode: nostrud dolore consequat country: WS phone: ad latitude: -18677000.514493212 longitude: -60626748.74683358 zoom: 49282517 codice: dolor ea est veniam districtName: dolor city: proident zip: dolor sit do adipisicing extra: - day: '1955-09-17' octorateProductId: 59709117 price: -58404383.18974792 quantity: -94253733 reference: amet veniam sunt et Excepteur - day: '2003-09-07' octorateProductId: -37370826 price: 10066153.04357244 quantity: 31624864 reference: consequat sit labore elit officia children: -7796201 related: - extra: - day: '1973-09-13' octorateProductId: 28331531 price: 52858371.05080637 quantity: -44566067 reference: aute consectetur - day: '1988-12-07' octorateProductId: 65427572 price: 53022363.759127915 quantity: 95529165 reference: nisi children: -10862486 currency: currencyCode: id incididunt do dolore defaultFractionDigits: 44461268 numericCode: -84010043 displayName: deserunt dolore ipsum symbol: quis laboris numericCodeAsString: dolore veniam velit lang: JA portalId: labori internalRoom: -10937429 totalGross: -77589449.00905812 roomGross: -91035079.61337897 guest: address: Duis amet incididunt Excepteur country: elit est do incididunt eu email: anim city: ullamco minim dolore labore phone: voluptate adipisicing in anim zip: aliquip Lorem cillum firstName: proident Lorem lastName: quis et officia laborum reservationExternal: id: -18605868 channelId: Ut propertyId: ex proident mollit octorateId: mollit sint room: id dolor in ipsum propertyReference: in culpa infants: 54018624 externalRefer: pariatur l createDate: '1967-06-23T18:06:50.312Z' updateDate: '1985-11-17T14:13:50.942Z' api: false externalRoom: i internalRate: -83066520 portalNotes: in nulla dolor velit qui pmsRoom: quis paidStayTax: 81928919.95935705 paidNotes: est veniam i totalPaid: -70440394.96344703 conversationId: veniam irure cleaningFee: -62981266.59294714 totalCommissions: -96155716.12793486 companyCollect: HOTEl daily: - day: '2001-12-30T19:12:53.424Z' price: 26212445.084135845 - day: '1942-12-06T15:16:53.752Z' price: -87651355.546878 streamCard: activationDate: '1969-11-25T05:42:33.110Z' expirationDate: '1969-03-06T16:05:29.718Z' currentBalance: 50793243.165685534 isVirtual: false token: et irure empty: false json: {} paymentMode: TRAVELCHEQUE place: id: 27356853 placeType: ACCOMODATION address: commodo pariatur exercitation irure city: comm zipCode: qui deserunt country: ZM phone: in aute latitude: 26976337.042860672 longitude: -20279923.244849667 zoom: -18267744 codice: esse ipsum qui commodo districtName: fugiat dolor esse startDate: '1943-04-14T06:36:33.971Z' specialRequests: dolore officia ipsum exer endDate: '2012-11-30T16:30:59.415Z' pax: 59957498 refer: sint status: CANCELLED - extra: - day: '2017-03-04' octorateProductId: 6479987 price: -94194397.02271108 quantity: 69901245 reference: irure - day: '1992-01-20' octorateProductId: -58629307 price: -92548047.06198661 quantity: 84320484 reference: dolore consequat children: -6561724 currency: currencyCode: est dolore defaultFractionDigits: 13218287 numericCode: -78551435 displayName: dolore sunt nisi in symbol: labori numericCodeAsString: occaecat consequat lang: DE portalId: cupidata internalRoom: 41439857 totalGross: -57802706.21854742 roomGross: 19181535.636508018 guest: address: ut country: consequat occaecat tempor laborum email: proident pariatur nulla incididunt exercitation city: ullamco phone: nulla do zip: sunt quis dolore firstName: laborum lastName: in dolore nisi magna mollit reservationExternal: id: -24164995 channelId: officia adipisicing ipsum commodo propertyId: enim in magna octorateId: ullamco consequat anim room: sit ullamco nostrud irure propertyReference: Excepteur dolore exercitation aliquip infants: 91678044 externalRefer: sunt anim createDate: '1947-01-31T10:37:58.713Z' updateDate: '1964-03-19T13:46:17.045Z' api: false externalRoom: eu do et dolore internalRate: -98171121 portalNotes: laboris ad ullamco pmsRoom: dolore nulla et ipsum paidStayTax: 57975318.35698146 paidNotes: fugi totalPaid: -96726514.79057235 conversationId: fugiat cleaningFee: 57742381.169671685 totalCommissions: -71702611.46805315 companyCollect: HOTEl daily: - day: '1986-07-26T20:04:11.861Z' price: 28002943.06947376 - day: '1945-12-10T09:37:52.129Z' price: 41149150.43056935 streamCard: activationDate: '1969-09-08T22:15:42.812Z' expirationDate: '1955-02-21T22:47:40.047Z' currentBalance: -8015570.095736146 isVirtual: false token: Excepteur sunt fugiat minim empty: false json: {} paymentMode: UNKNOWN place: id: -54651458 placeType: ROOM address: est non adipisicing ad city: commodo deserunt zipCode: ullamco nulla qui cupidatat country: NE phone: enim id sunt latitude: -37089003.877104074 longitude: -88204370.08191791 zoom: -78985514 codice: est nisi districtName: sunt velit nostrud quis deserunt startDate: '1965-12-26T17:18:20.032Z' specialRequests: esse exer endDate: '1958-05-13T19:31:34.180Z' pax: 12584432 refer: non in anim officia tempor status: WAITING propertyReference: cupidatat dolore dolor infants: 35070726 internalRate: -19028931 companyCollect: NONE daily: - day: '1952-02-29T13:00:18.718Z' price: -42433803.06861964 - day: '1962-06-21T10:47:12.556Z' price: 43265339.69111946 streamCard: activationDate: '1947-10-25T03:53:41.638Z' expirationDate: '2008-08-04T02:43:13.346Z' currentBalance: 76973254.82536885 isVirtual: false token: ut aliqua dolor empty: true json: {} paymentMode: CHEQUE /connect/rest/v1/reservation/{accommodation}/{id}: put: tags: - rest/v1 > Each User One Login > reservation > {accommodation} > {id} summary: update Reservation description: Update an existing reservation requestBody: content: '*/*': schema: type: string example: >- "{\n \"channelId\": 142,\n \"status\": \"CONFIRMED\",\n \"checkin\": \"2024-01-22T00:00:00+00:00\",\n \"checkout\": \"2024-01-26T00:00:00+00:00\",\n \"createTime\": \"2023-12-07T19:57:20+00:00\",\n \"updateTime\": \"2024-01-18T16:06:50+00:00\",\n \"refer\": \"4124750800\",\n \"roomGross\": 200,\n \"cleaningFee\": 0,\n \"totalGuest\": 1,\n \"totalInfants\": 0,\n \"totalChildren\": 0,\n \"product\": 588663,\n \"guests\": [\n {\n \"type\": \"BOOKER\",\n \"givenName\": \"Simona\",\n \"familyName\": \"Mirabella\",\n \"email\": \"smirab.333222@guest.booking.com\",\n \"phone\": \"+393271545522\",\n \"city\": \".\",\n \"language\": \"IT\",\n \"nationality\": \"IT\"\n }\n ]\n}" security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '514653' - name: id in: path schema: type: integer required: true description: '(Required) ' example: '105543796' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' patch: tags: - rest/v1 > Each User One Login > reservation > {accommodation} > {id} summary: update Reservation Copy description: Update an existing reservation requestBody: content: '*/*': schema: type: string example: '"{\n \"product\": 329327\n}"' security: - bearerAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '656558' - name: id in: path schema: type: integer required: true description: '(Required) ' example: '100717542' responses: '200': description: OK headers: Server: schema: type: string example: 'Payara Server 5.2021.7 #badassfish' X-Powered-By: schema: type: string example: >- Servlet/4.0 JSP/2.3 (Payara Server 5.2021.7 #badassfish Java/Ubuntu/11) request-id: schema: type: string example: a9320dc5-ddaa-4f26-92dc-48999b968183 X-RateLimit-Remaining: schema: type: integer example: '66' X-RateLimit-Remaining-681002: schema: type: integer example: '66' Content-Type: schema: type: string example: application/json Content-Length: schema: type: integer example: '1979' X-Frame-Options: schema: type: string example: SAMEORIGIN content: application/json: schema: type: object example: json: {} refer: RK6XE6 channelId: 233 channelRefer: RK6XE6 status: CONFIRMED checkin: 2021-11-10T12:00:00Z[UTC] checkout: 2021-11-10T23:00:00Z[UTC] createTime: 2021-11-10T10:27:26Z[UTC] updateTime: 2021-11-10T10:27:26Z[UTC] children: 0 guests: - checkin: '2021-11-10' checkout: '2021-11-11' city: '' email: Ricky@octorate.com familyName: Martin givenName: Ricky language: EN phone: +39 338764432 source: PORTAL type: BOOKER infants: 0 pmsProduct: 330933 roomCode: code: '123' pmsProduct: 330933 reservation: 95318269 source: API roomGross: 34996.5 totalGross: 34996.5 totalGuest: 1 accommodation: address: Piazza campo di fiori, 5 city: Roma currency: EUR id: '681002' latitude: 41.8952157 longitude: 12.4723665 name: devin_house CHANNELS phoneNumber: '+3933470000000' timeZone: Europe/Rome zipCode: '00100' arrivalTime: '13:00:00' channelName: Octorate currency: EUR firstName: Ricky freeCancellation: false guestMailAddress: Ricky@octorate.com guestsList: Ricky Martin id: 95318269 lastName: Martin paymentStatus: UNPAID paymentType: UNKNOWN payments: [] priceBreakdown: - type: DAILY_ROOM_PRICE name: null createTime: null day: 2021-11-09T23:00:00Z[UTC] price: 34996.5 reference: '14382644' externalId: null included: true product: null quantity: null - type: ROOM_NET name: null createTime: null day: null price: 34996.5 reference: null externalId: null included: true product: null quantity: null - type: VAT name: null createTime: null day: null price: 0 reference: null externalId: null included: true product: null quantity: null - type: TOURIST_TAX name: null createTime: null day: null price: 20 reference: null externalId: null included: false product: null quantity: null product: 324447 roomName: Single Room roomNameGuest: '' totalChildren: 0 totalInfants: 0 touristTax: 20 '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /connect/rest/v1/reservation/{accommodation}: get: tags: - rest/v1 > Each User One Login > reservation summary: find Reservation All Copy description: >- Retrieve the reservation which checkin is in the future for the user accommodation and its network parameters: - name: size in: query schema: type: integer example: '50' - name: accommodation in: path schema: type: integer required: true example: '89422' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 212 checkin: '1954-02-21T13:53:00.051Z' checkout: '2008-02-17T08:26:16.032Z' createTime: '1957-05-24T16:02:09.074Z' guests: - checkin: '1952-05-30' checkout: '1993-01-12' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '2015-09-14' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: velit Duis do est dolor address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1955-04-18' documentIssuePlace: Roma documentExpire: '1966-12-09T22:15:57.188Z' sex: MALE - checkin: '1951-01-17' checkout: '1989-01-01' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '2013-03-22' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: velit dolor address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1995-11-21' documentIssuePlace: Roma documentExpire: '1964-04-27T08:10:50.248Z' sex: MALE product: 1222222 refer: A2DD123_AA2211 status: CONFIRMED totalChildren: 0 totalGuest: 0 totalInfants: 0 updateTime: '2002-08-30T11:27:51.237Z' channelRefer: A12FF232DDDDDD pmsProduct: 1200122 roomGross: 47.56 channelNotes: Reservation payment facilitated through a virtual card privateNotes: >- Customer says is not sure whether will arrive on 25th or 26th of March, Payment was agreed but not yet arrived priceBreakdown: - type: DAILY_ROOM_PRICE createTime: '1943-10-23T10:40:38.287Z' day: '1984-06-09' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: -29607387 included: false - type: DAILY_ROOM_PRICE createTime: '1997-04-24T09:28:24.943Z' day: '1987-08-25' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 75064949 included: false id: 123123 channelName: BOOKING currency: currencyCode: occaec defaultFractionDigits: 29164650 numericCode: 9660205 displayName: occaecat non ad symbol: occaecat sunt ipsum Ut culpa numericCodeAsString: eu consectetur amet touristTax: 12 paymentType: CREDITCARD paymentStatus: UNPAID freeCancellation: true paidCancellation: '1998-01-17T21:47:01.206Z' creditCard: token: a2uuy-uuyte-76433-hyt453-kkssst bank: ING DIRECT Bv. bankCountry: IT scheme: MASTERCARD activationDate: '2015-04-24T17:54:50.339Z' expireDate: '1988-03-17T03:18:14.898Z' lastUpdate: '2019-12-13T19:29:39.586Z' cvvAvailable: true cvvCleared: true cardUsed: true cardVirtual: false payments: - id: 72947187 insertTime: '1941-09-08T07:16:27.022Z' referenceTime: '2014-12-27T14:59:03.836Z' description: esse enim dolore paymentMode: CREDITCARD amount: 34747152.62826723 cityTaxAmount: 28655679.12853159 user: id: 42561 username: anim minim firstname: ad codpromo: mollit codice: Excepteur id amet adipisicing eiusmod type: ADMIN scheduled: false scheduledTime: '1963-07-11T19:04:19.793Z' scheduledAmount: -4020235.6350085735 - id: 54368805 insertTime: '2009-09-16T22:55:24.402Z' referenceTime: '2011-03-10T04:52:57.487Z' description: l paymentMode: CREDITCARD amount: 39437868.648963004 cityTaxAmount: 25018179.01765655 user: id: -39974462 username: cillum magna Duis firstname: cupidatat ea codpromo: dolor Ut aliquip do codice: labore ut type: AFFILIATE scheduled: false scheduledTime: '2002-08-07T07:49:53.825Z' scheduledAmount: 59106523.86677575 linkedReservations: - -69149013 - -18941566 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: reprehenderit id: dolor id enim dolor dstsavings: -87678705 rawOffset: -30453616 phoneNumber: cupidatat sed elit velit address: incididunt quis non latitude: -10064094.47223495 longitude: -14583919.060254753 zipCode: est enim city: esse ad qui ipsum roomName: in sed laborum in id roomNameGuest: in commodo exercitation guestsList: velit consequat guestMailAddress: sit arrivalTime: voluptate id Ut proident Lorem split: splitRoom: id: 54628234 name: amet ad dolor nulla splitAccommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: laborum est id: aute commodo dstsavings: 555274 rawOffset: 99590801 phoneNumber: aliqua ad qui address: nostrud labore fugiat deserunt in latitude: -9125102.619396493 longitude: 23500862.086812407 zipCode: amet city: id voluptate connection: id: -4713558 name: nulla et splitStart: '1962-09-29' address: cupidatat minim ipsum Lorem country: Ut nostrud guest: address: commodo incididunt country: mag email: Duis nulla commodo exercitation city: fugiat veniam ut est phone: nisi Lorem lab zip: aute elit firstName: aute fugiat lastName: aliquip Duis dolore magna reservationExternal: id: 12263603 channelId: sunt labore ipsum anim in propertyId: ullamco minim elit non octorateId: aliquip room: elit externalRefer: reprehenderit fugiat et aute api: true totalPaid: 57662020.78091797 conversationId: reprehenderit adipisicing cleaningFee: -93259221.5560247 place: id: 56807159 placeType: ROOM address: magna deserunt city: in nostrud dolore pariatur minim zipCode: tempor esse mollit eu dolor country: SD phone: culpa velit labore aliqua cupidatat latitude: -2260056.644556746 longitude: 3940776.049089089 zoom: -20440540 codice: exercitation voluptate dolor officia districtName: nulla est city: laboris Ut zip: ea laborum occaecat irure extra: - day: '2014-02-26' octorateProductId: 94932007 price: -47710656.373175554 quantity: -22710441 reference: ut veniam sit - day: '1941-07-02' octorateProductId: 21566170 price: -609729.8614653051 quantity: 1182326 reference: ut Lorem e children: 58503614 related: - extra: - day: '1985-12-30' octorateProductId: -81860308 price: -80203323.75082356 quantity: 41804828 reference: anim Lorem ut incididunt - day: '1960-03-26' octorateProductId: 444587 price: 89154643.20699275 quantity: -81970673 reference: ut aliqua sint nisi id children: 29139591 currency: currencyCode: tempor defaultFractionDigits: 64103835 numericCode: -7528958 displayName: nostrud Ut ea symbol: dolore l numericCodeAsString: consequat sint ea lang: FR portalId: voluptate internalRoom: 36731108 totalGross: 68793444.69090384 roomGross: 75837341.6339693 guest: address: sit mollit voluptate eiusmod in country: veniam email: esse fugiat cillum q city: labore nulla phone: minim zip: proident dolore cillum et firstName: in adipisicing lastName: esse cillum do minim reservationExternal: id: -8793190 channelId: e propertyId: consequat in octorateId: cillum cul room: veniam non reprehend propertyReference: velit minim enim nisi infants: -58214550 externalRefer: elit exercitation ea laborum nulla createDate: '1951-06-19T14:31:47.519Z' updateDate: '1959-11-29T16:39:44.167Z' api: true externalRoom: Duis nulla pariatur amet laboris internalRate: -30933908 portalNotes: ad in pmsRoom: in Ut cillum consequat paidStayTax: 25061640.656376347 paidNotes: laborum et esse dolor totalPaid: 69558990.86787155 conversationId: occaecat reprehenderit cleaningFee: 31289945.06019564 totalCommissions: 92918374.60349962 companyCollect: HOTEl daily: - day: '1986-01-15T09:32:35.275Z' price: -32859310.638308153 - day: '1941-12-14T01:09:48.689Z' price: -9573642.540636346 streamCard: activationDate: '1963-08-01T22:19:17.107Z' expirationDate: '1943-04-11T15:18:10.532Z' currentBalance: -21638362.938622266 isVirtual: false token: culpa proident Ut nisi eu empty: true json: {} paymentMode: CHEQUE place: id: -58407056 placeType: ROOM address: sunt mollit laboris anim city: id Excepteur culpa proident zipCode: aute in consectetur Lorem country: RO phone: sunt adipisicing esse dolor laboris latitude: -19805418.736995548 longitude: 7972770.736842528 zoom: 60174662 codice: repr districtName: nulla incididunt ut startDate: '2000-09-10T15:33:07.860Z' specialRequests: amet aliquip consectetur ullamco endDate: '1960-11-01T22:37:39.260Z' pax: 24955822 refer: consequat sed cillum status: CANCELLED - extra: - day: '1957-02-27' octorateProductId: -2111338 price: -4976197.3369923085 quantity: 39448589 reference: dolore incididunt - day: '2000-02-04' octorateProductId: -59903174 price: 15727862.718206301 quantity: 24241612 reference: dolor nostrud children: 44397241 currency: currencyCode: Excepteur nostrud est laboris commodo defaultFractionDigits: 14822178 numericCode: -47396401 displayName: cupidatat adipisicing c symbol: incididunt ut numericCodeAsString: id velit amet mollit cillum lang: PT portalId: laboris quis nisi internalRoom: 54466836 totalGross: -47047319.73711995 roomGross: 20942155.05633779 guest: address: mollit veniam magna nulla commodo country: dolore pariatur id do email: veniam adipisicing tempor in city: sint nostrud phone: volu zip: fugiat nostrud adipisicing do firstName: amet ea laborum veniam cupidatat lastName: cillum velit ea reservationExternal: id: 76649686 channelId: ea nostrud propertyId: sed deserunt proident octorateId: incididu room: ut nisi dolore propertyReference: aliqua in exercitation infants: -92825747 externalRefer: dol createDate: '1959-01-28T02:07:00.410Z' updateDate: '1941-08-03T21:48:01.920Z' api: false externalRoom: laboris volupt internalRate: 59661630 portalNotes: velit aute pmsRoom: reprehenderit paidStayTax: -37536044.123016946 paidNotes: magna amet anim adipisicing totalPaid: 83242039.06346384 conversationId: velit cleaningFee: -95131141.41573621 totalCommissions: 76549337.37763569 companyCollect: NONE daily: - day: '2015-10-18T08:59:39.607Z' price: 93471806.20279527 - day: '1983-02-15T23:13:39.388Z' price: -33618948.538989104 streamCard: activationDate: '1980-08-22T10:47:58.151Z' expirationDate: '2002-06-04T13:03:12.218Z' currentBalance: 44358085.61196822 isVirtual: true token: elit velit empty: true json: {} paymentMode: TREASURY_OFFICE place: id: -49456435 placeType: ACCOMODATION address: officia sed eu Ut city: eu minim Dui zipCode: Lorem sit Ut eiusmod aliqua country: MQ phone: fugiat aute latitude: 42539257.12307605 longitude: -53768679.70194774 zoom: -69229536 codice: consectetur ut elit districtName: ut Ut laboris startDate: '1968-06-10T23:40:14.636Z' specialRequests: voluptate consequat endDate: '2017-09-24T21:01:47.707Z' pax: 23999882 refer: laboris status: CANCELLED propertyReference: ea quis in infants: 58774237 internalRate: -10468000 companyCollect: COMPANY daily: - day: '1969-03-27T13:48:50.407Z' price: 59563646.48520219 - day: '1968-11-07T05:47:05.093Z' price: 85669699.7254276 streamCard: activationDate: '2011-10-18T10:44:34.585Z' expirationDate: '1966-01-02T23:27:37.149Z' currentBalance: 13033300.82720095 isVirtual: false token: et empty: true json: {} paymentMode: CREDITCARD '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' post: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: create Single Reservation Alberto description: Create a new Reservation requestBody: content: '*/*': schema: type: string example: >- "{\n \"channelId\": 233,\n \"status\": \"CONFIRMED\",\n \"checkin\": \"2021-04-10T00:00:00+00:00\",\n \"checkout\": \"2021-04-14T00:00:00+00:00\",\n \"createTime\": \"2021-04-09T12:30:25+00:00\",\n \"updateTime\": \"2021-04-09T12:30:25+00:00\",\n \"refer\": \"1901d96\",\n \"roomGross\": 180.0,\n \"cleaningFee\": 0,\n \"totalGuest\": 1,\n \"totalInfants\": 0,\n \"totalChildren\": 0,\n \"product\": 284638,\n \"guests\": [\n {\n \"type\": \"BOOKER\",\n \"givenName\": \"Pierluigi\",\n \"familyName\": \"Mirizzi\",\n \"phone\": \"+393470518923\",\n \"language\": \"IT\"\n }\n ]\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '9121856222' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /rest/v1/reservation/{accommodation}: post: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: create Single Reservation description: Create a new Reservation requestBody: content: '*/*': schema: type: string example: >- "{\n \"channelId\": 233,\n \"checkin\": \"2021-06-03T22:00:00+00:00[UTC]\",\n \"checkout\": \"2021-06-04T22:00:00+00:00[UTC]\",\n \"createTime\": \"2021-06-02T12:35:54+00:00[UTC]\",\n \"guests\": [\n {\n \"id\": null,\n \"type\": \"BOOKER\",\n \"givenName\": \"DOMINIQUE\",\n \"familyName\": \"HERAULT\",\n \"city\": \".\",\n \"email\": \"t.ornon@my-groom-service.com\",\n \"phone\": \"0648684625\",\n \"address\": \".\",\n \"zipCode\": \"0\",\n \"language\": \"FR\",\n \"nationality\": \"FR\"\n }\n ],\n \"product\": 386759,\n \"roomGross\": 80,\n \"status\": \"CONFIRMED\",\n \"totalGuest\": 2,\n \"totalInfants\": 0,\n \"updateTime\": \"2021-06-02T12:35:54+00:00[UTC]\",\n \"channelNotes\": \"1 table pour 2 pour le diner\"\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '681002' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /rest/v1/reservation/{accommodation}/group/{refer}: delete: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: delete Group Reservations description: >- Delete a group of reservations, sharing the same refer. (Multiroom reservations) (This method can be used as alternative of update reservation to create a cancellation) parameters: - name: accommodation in: path schema: type: string required: true description: '(Required) ' example: qui velit - name: refer in: path schema: type: string required: true description: (Required) Octorate refer for reservations example: qui velit responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: '*/*' content: text/plain: schema: type: string example: '' /rest/v1/reservation/{accommodation}/search: get: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: Booking Engine Search description: Perform an API search in the Booking Engine like the user would do parameters: - name: ids[] in: query schema: type: number description: The product ids to restrict search example: '-41387376' - name: checkin in: query schema: type: string description: Date of the checkin in format yyyy-MM-dd example: '1960-06-17' - name: checkout in: query schema: type: string description: Date of the checkout in format yyyy-MM-dd example: '1987-03-11' - name: currency in: query schema: type: string description: Expected currency result (in ISO3 CODE) example: qui velit - name: availcheck in: query schema: type: boolean description: If true check availability example: 'true' - name: accommodation in: path schema: type: string required: true description: (Required) The accommodation id example: qui velit responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: room: 23178255 checkin: occaecat dolor eiusmod mollit ex checkout: adipisicing ullamco dolor et bookUrl: irure nostrud Lorem in price: -71341363.93750587 availability: 99266952 guests: 84888176 discount: id: 11900719 name: in irure dolore value: 80500258.78705049 description: officia enim netRate: -68865780.73963468 isPercent: false bookingFee: 10341529.684480965 hotelFee: -10573025.04104425 resortFee: 10941249.846192628 serviceCharge: 51909634.440004915 local_tax: 18271737.714510918 vat: 56213283.45017478 final_rate: -3090269.998925656 bookingFee: 2360191.9314429164 hotelFee: -11741451.17848453 resortFee: -20237621.498341873 serviceCharge: 64231912.4778496 breakfastPrice: 27496417.397245303 cleaningPrice: -52061141.21111045 localTax: -51086292.8364209 vat: -23672990.14158091 netRate: 88548313.72241044 basePrice: -35347445.70998667 mealCode: cupidatat pariatur freeCancellation: false paymentType: consectetur fugiat ex adipisicing velit currency: in Ut roomsLeft: 56964461 breakfastIncluded: false minDeposit: -66779041.51636231 cancellationValue: -86558897.62132794 cancellationPolicy: Ut in elit cancellationFreeDays: 8477106 '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/reservation/bulk/{accommodation}: post: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: create Many Reservations description: Create Bulk reservations requestBody: content: '*/*': schema: type: string example: >- "{\n \"reservations\": [\n {\n \"status\": \"CONFIRMED\",\n \"refer\": \"TEST_OCTO_SHARE_REFER_A\",\n \"channelId\": 270,\n \"product\": 464923,\n \"checkin\": \"2021-04-10T22:00:00Z[UTC]\",\n \"checkout\": \"2021-04-12T13:00:00Z[UTC]\",\n \"roomGross\": 45,\n \"totalGuest\": 2,\n \"totalChildren\": 0,\n \"totalInfants\": 0,\n \"guests\": [\n {\n \"type\": \"BOOKER\",\n \"givenName\": \"Mario\",\n \"familyName\": \"Rossi&Friends\",\n \"email\": \"test@libero.it\",\n \"language\": \"IT\"\n }\n ]\n },\n {\n \"status\": \"CONFIRMED\",\n \"refer\": \"TEST_OCTO_SHARE_REFER_A\",\n \"channelId\": 270,\n \"product\": 464923,\n \"checkin\": \"2021-04-10T22:00:00Z[UTC]\",\n \"checkout\": \"2021-04-12T13:00:00Z[UTC]\",\n \"roomGross\": 45,\n \"totalGuest\": 2,\n \"totalChildren\": 0,\n \"totalInfants\": 0,\n \"guests\": [\n {\n \"type\": \"BOOKER\",\n \"givenName\": \"Mario\",\n \"familyName\": \"Rossi&Friends\",\n \"email\": \"test@libero.it\",\n \"language\": \"IT\"\n }\n ]\n }\n ]\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: accommodation in: path schema: type: integer required: true description: '(Required) ' example: '681002' responses: '200': description: OK headers: Server: schema: type: string example: 'Payara Server 5.2022.4 #badassfish' X-Powered-By: schema: type: string example: >- Servlet/4.0 JSP/2.3 (Payara Server 5.2022.4 #badassfish Java/JetBrains s.r.o./17) Access-Control-Allow-Origin: schema: type: string example: http://localhost:4200 Access-Control-Allow-Methods: schema: type: string example: PATCH, DELETE Access-Control-Allow-Headers: schema: type: string example: Origin, X-Requested-With, Content-Type, Accept, Authorization Access-Control-Allow-Credentials: schema: type: boolean example: 'true' request-id: schema: type: string example: 9723f95e-dfa5-4588-aff9-a98e7a8a00a8 X-RateLimit-Remaining: schema: type: integer example: '217' X-RateLimit-Remaining-681002: schema: type: integer example: '217' Content-Type: schema: type: string example: application/json Content-Length: schema: type: integer example: '3766' X-Frame-Options: schema: type: string example: SAMEORIGIN content: application/json: schema: type: object example: data: - cityTaxZero: false json: {} refer: TEST_OCTO_SHARE_REFER_A channelId: 270 channelRefer: TEST_OCTO_SHARE_REFER_A status: CONFIRMED checkin: 2021-04-11T11:00:00Z[UTC] checkout: 2021-04-11T22:00:00Z[UTC] createTime: 2023-03-22T08:08:11.917Z[UTC] updateTime: 2023-03-22T08:08:11Z[UTC] children: 0 guests: - checkin: '2021-04-11' checkout: '2021-04-12' email: test@libero.it familyName: Rossi&Friends givenName: Mario language: IT phone: '' source: PORTAL type: BOOKER infants: 0 roomGross: 45 totalGross: 45 totalGuest: 2 accommodation: address: Via test 1 checkinEnd: 18 checkinStart: 13 checkout: 22 city: ROMA currency: EUR id: '681002' latitude: 41.9275688 longitude: 12.3929956 name: devin_house channel phoneNumber: '+3933470000000' timeZone: Europe/Rome timeZoneOffset: '+01:00' zipCode: '00055' arrivalTime: '13:00:00' channelName: octoevo currency: EUR firstName: Mario freeCancellation: true groupId: 0 grouped: false guestMailAddress: test@libero.it guestsList: Mario Rossi&Friends id: 101277635 invoice: [] itemCompleted: false lastName: Rossi&Friends noShow: false paymentStatus: UNPAID paymentType: UNKNOWN payments: [] priceBreakdown: - type: ROOM_NET name: null createTime: null day: null price: 45 reference: null externalId: null included: true product: null quantity: null - type: VAT name: null createTime: null day: null price: 0 reference: null externalId: null included: true product: null quantity: null - type: TOURIST_TAX name: null createTime: null day: null price: 4.5 reference: null externalId: null included: false product: null quantity: null product: 464923 ratePlan: 1970 roomName: BASE roomNameGuest: '' totalChildren: 0 totalInfants: 0 totalPaid: 0 touristTax: 4.5 - cityTaxZero: false json: {} refer: TEST_OCTO_SHARE_REFER_A channelId: 270 channelRefer: TEST_OCTO_SHARE_REFER_A status: CONFIRMED checkin: 2021-04-11T11:00:00Z[UTC] checkout: 2021-04-11T22:00:00Z[UTC] createTime: 2023-03-22T08:08:12.987Z[UTC] updateTime: 2023-03-22T08:08:12Z[UTC] children: 0 guests: - checkin: '2021-04-11' checkout: '2021-04-12' email: test@libero.it familyName: Rossi&Friends givenName: Mario language: IT phone: '' source: PORTAL type: BOOKER infants: 0 roomGross: 45 totalGross: 45 totalGuest: 2 accommodation: address: Via test 1 checkinEnd: 18 checkinStart: 13 checkout: 22 city: ROMA currency: EUR id: '681002' latitude: 41.9275688 longitude: 12.3929956 name: devin_house channel phoneNumber: '+3933470000000' timeZone: Europe/Rome timeZoneOffset: '+01:00' zipCode: '00055' arrivalTime: '13:00:00' channelName: octoevo currency: EUR firstName: Mario freeCancellation: true groupId: 0 grouped: false guestMailAddress: test@libero.it guestsList: Mario Rossi&Friends id: 101277636 invoice: [] itemCompleted: false lastName: Rossi&Friends noShow: false paymentStatus: UNPAID paymentType: UNKNOWN payments: [] priceBreakdown: - type: ROOM_NET name: null createTime: null day: null price: 45 reference: null externalId: null included: true product: null quantity: null - type: VAT name: null createTime: null day: null price: 0 reference: null externalId: null included: true product: null quantity: null - type: TOURIST_TAX name: null createTime: null day: null price: 4.5 reference: null externalId: null included: false product: null quantity: null product: 464923 ratePlan: 1970 roomName: BASE roomNameGuest: '' totalChildren: 0 totalInfants: 0 totalPaid: 0 touristTax: 4.5 '400': description: Bad Request headers: Server: schema: type: string example: 'Payara Server 5.2022.4 #badassfish' X-Powered-By: schema: type: string example: >- Servlet/4.0 JSP/2.3 (Payara Server 5.2022.4 #badassfish Java/JetBrains s.r.o./17) Access-Control-Allow-Origin: schema: type: string example: http://localhost:4200 Access-Control-Allow-Methods: schema: type: string example: PATCH, DELETE Access-Control-Allow-Headers: schema: type: string example: Origin, X-Requested-With, Content-Type, Accept, Authorization Access-Control-Allow-Credentials: schema: type: boolean example: 'true' request-id: schema: type: string example: 6dfaced4-35c8-47c5-90ec-a882d7c3b366 X-RateLimit-Remaining: schema: type: integer example: '213' X-RateLimit-Remaining-681002: schema: type: integer example: '213' Content-Type: schema: type: string example: application/json Connection: schema: type: string example: close Content-Length: schema: type: integer example: '377' X-Frame-Options: schema: type: string example: SAMEORIGIN content: application/json: schema: type: object example: element: '' message: The value , could not be accepted nested: - human_name: Rooms machine_name: $.[0]product message: Field Rooms is required. type: RejectRequired - human_name: The resource {0} cannot be accepted or interpreted message: >- The resource [Reservation] cannot be accepted or interpreted type: RejectInvalid type: ApiParamsExemption '415': description: Unsupported Media Type headers: Access-Control-Allow-Origin: schema: type: string example: https://admin.octorate.com Access-Control-Allow-Methods: schema: type: string example: PATCH, DELETE Access-Control-Allow-Headers: schema: type: string example: Origin, X-Requested-With, Content-Type, Accept, Authorization Access-Control-Allow-Credentials: schema: type: boolean example: 'true' Content-Type: schema: type: string example: application/json Content-Length: schema: type: integer example: '390' Strict-Transport-Security: schema: type: string example: max-age=7776000 content: application/json: schema: type: object example: message: HTTP 415 Unsupported Media Type nested: - message: HTTP 415 Unsupported Media Type type: NotSupportedException suggestion: >- You should check the headers inside your call, the body provided and what kind of response did you expect. Probably the Content-Type is not right or the content you have provided doesn't respect the standards. type: ApiUnprocessableEntity /connect/rest/v1/reservation/{accommodation}/statistics: get: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: statistics parameters: - name: accommodation in: path schema: type: integer required: true example: '16997' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/citytax/{accommodation}: get: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: city tax filled? parameters: - name: reservations[] in: query schema: type: integer example: '101502850' - name: accommodation in: path schema: type: integer required: true example: '16439' responses: '200': description: OK headers: Server: schema: type: string example: 'Payara Server 6.2023.4 #badassfish' X-Powered-By: schema: type: string example: >- Servlet/6.0 JSP/3.1 (Payara Server 6.2023.4 #badassfish Java/Oracle Corporation/17) Access-Control-Allow-Origin: schema: type: string example: http://localhost:4200 Access-Control-Allow-Methods: schema: type: string example: PATCH, PUT, DELETE Access-Control-Allow-Headers: schema: type: string example: Origin, X-Requested-With, Content-Type, Accept, Authorization Access-Control-Allow-Credentials: schema: type: boolean example: 'true' request-id: schema: type: string example: 6a467061-f780-4626-b691-d3df34a10f19 X-RateLimit-Remaining: schema: type: integer example: '287' X-RateLimit-Remaining-16439: schema: type: integer example: '286' Content-Type: schema: type: string example: application/json Content-Length: schema: type: integer example: '25' X-Frame-Options: schema: type: string example: SAMEORIGIN content: application/json: schema: type: object example: data: - id: 3088336 /connect/rest/v1/reservation/{accommodation}/sentEmails: get: tags: - rest/v1 > Each User One Login > reservation > {accommodation} summary: Read mails parameters: - name: refer in: query schema: type: string - name: accommodation in: path schema: type: integer required: true example: '16997' responses: '200': description: Successful response content: application/json: {} /rest/v1/reservation/681002/93892893/split: post: tags: - rest/v1 > Each User One Login > reservation > Split summary: CREATE / MODIFY SPLIT requestBody: content: '*/*': schema: type: string example: >- "{\n \"splitRoom\":{\"id\":389636},\n \"splitAccommodation\":{\"id\":\"681002\"},\n \"splitStart\":\"2021-06-24\"\n} " parameters: - name: Authorization in: header schema: type: string example: Bearer test - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/reservation/681002/93892893/split: delete: tags: - rest/v1 > Each User One Login > reservation > Split summary: DELETE SPLIT parameters: - name: Authorization in: header schema: type: string example: Bearer test - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/payment/OCTORATE/HyperGuest/addCard: post: tags: - rest/v1 > Each User One Login > reservation summary: Add Card description: >- We're PCI compliant, in case you need to add a new card to a reservation we ask you to communicate the details to our partner.
If you need this option, please contact us in order to prepare the necessary staff.
Anyway here there are some of the details of the call you will do to our partner. It's in the same format of the others APIs. You still need to provide the token to access the property. Prepare a fallback scenario in case Octorate or our partner replies with an error. requestBody: content: '*/*': schema: type: string example: >- "{\n \"holder\": {\n \"familyName\": \"Test\",\n \"givenName\": \"Test\",\n \"zip\": \"00100\",\n \"city\": \"Rome\"\n },\n \"refer\": \"APIPB8BN8\",\n \"ccsToken\": \"123\",\n \"otaName\": \"Hyperguest\"\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 212 checkin: '1998-04-07T13:19:31.533Z' checkout: '1986-01-21T01:33:30.129Z' createTime: '1956-05-30T19:21:31.379Z' guests: - checkin: '1980-06-26' checkout: '1986-12-12' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1947-06-11' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: eiusmod enim address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1963-09-26' documentIssuePlace: Roma documentExpire: '2002-12-15T00:00:44.402Z' sex: MALE - checkin: '1972-02-06' checkout: '1975-07-05' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1943-06-02' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: et labor address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '2020-02-24' documentIssuePlace: Roma documentExpire: '1984-01-30T01:04:30.106Z' sex: MALE product: 1222222 refer: A2DD123_AA2211 status: CONFIRMED totalChildren: 0 totalGuest: 0 totalInfants: 0 updateTime: '1961-09-12T02:17:49.980Z' channelRefer: A12FF232DDDDDD pmsProduct: 1200122 roomGross: 47.56 channelNotes: Reservation payment facilitated through a virtual card privateNotes: >- Customer says is not sure whether will arrive on 25th or 26th of March, Payment was agreed but not yet arrived priceBreakdown: - type: DAILY_ROOM_PRICE createTime: '2008-04-10T07:00:33.394Z' day: '1996-12-30' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 33944167 included: false - type: DAILY_ROOM_PRICE createTime: '2001-11-07T19:07:43.396Z' day: '1958-11-09' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 10624519 included: true id: 123123 channelName: BOOKING currency: currencyCode: fugiat ut ut quis defaultFractionDigits: -73482270 numericCode: -26403502 displayName: Ut eiusmod irure symbol: elit commodo anim numericCodeAsString: exercitation touristTax: 12 paymentType: CREDITCARD paymentStatus: UNPAID freeCancellation: false paidCancellation: '2003-05-06T23:34:38.675Z' creditCard: token: a2uuy-uuyte-76433-hyt453-kkssst bank: ING DIRECT Bv. bankCountry: IT scheme: MASTERCARD activationDate: '2013-06-28T12:25:45.220Z' expireDate: '1994-04-08T13:27:52.576Z' lastUpdate: '2005-08-12T16:18:41.416Z' cvvAvailable: false cvvCleared: false cardUsed: false cardVirtual: true payments: - id: -56127074 insertTime: '1955-08-26T11:00:34.042Z' referenceTime: '1963-02-03T12:56:15.924Z' description: nulla aliquip paymentMode: CREDITCARD amount: -12937365.574373677 cityTaxAmount: 17884334.010387942 user: id: -135282 username: tempor ullamco in culpa firstname: ad in aliquip magna codpromo: labore ut ipsum codice: laborum sint quis deserunt labore type: USER scheduled: true scheduledTime: '1953-02-07T05:57:53.606Z' scheduledAmount: -92036134.19708799 - id: -46277909 insertTime: '1978-11-07T14:46:55.618Z' referenceTime: '2015-02-26T14:24:40.786Z' description: irure cupidatat fugiat paymentMode: CREDITCARD amount: 87324688.30332795 cityTaxAmount: -4032361.6976282448 user: id: 94851837 username: Lorem anim elit velit firstname: Ut ut codpromo: pariatur elit codice: cupidatat dolore type: ADMIN scheduled: false scheduledTime: '1969-08-14T10:08:15.275Z' scheduledAmount: -15304188.207770735 linkedReservations: - -57192556 - 75587101 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: aliqua eiusmod anim minim id: sit dstsavings: -70417523 rawOffset: 85525228 phoneNumber: Excepteur sed Ut aute dolor address: laboris adipisicing minim latitude: -82631170.96219333 longitude: 6846293.061984941 zipCode: commodo aute city: ipsum roomName: ut occaecat do roomNameGuest: nostrud ipsum guestsList: est Ut guestMailAddress: ut arrivalTime: ex amet split: splitRoom: id: 36452220 name: enim proiden splitAccommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: cillum id: cillum ad elit dstsavings: -10397929 rawOffset: -35222741 phoneNumber: ut sed in address: ut dolore minim cillum amet latitude: -67882608.26251987 longitude: 52765133.69408736 zipCode: fugiat nisi city: nostrud connection: id: 50591996 name: ea laborum splitStart: '1999-10-14' address: est do amet country: magna qui labore consectetur guest: address: consectetur country: sunt conse email: dolor nostrud elit city: labore phone: Duis culpa irure enim zip: culpa magna firstName: non in est Lorem lastName: reprehenderit incididunt consectetur sint proident reservationExternal: id: 37860786 channelId: sint do magna propertyId: repreh octorateId: ullamco tempor sit room: aliqua externalRefer: id api: true totalPaid: 60482471.921477824 conversationId: officia Ut ad cleaningFee: -60828494.92426212 place: id: 88344960 placeType: ROOM address: elit Excepteur city: qui tempor adipisicing zipCode: nostrud dolore consequat country: WS phone: ad latitude: -18677000.514493212 longitude: -60626748.74683358 zoom: 49282517 codice: dolor ea est veniam districtName: dolor city: proident zip: dolor sit do adipisicing extra: - day: '1955-09-17' octorateProductId: 59709117 price: -58404383.18974792 quantity: -94253733 reference: amet veniam sunt et Excepteur - day: '2003-09-07' octorateProductId: -37370826 price: 10066153.04357244 quantity: 31624864 reference: consequat sit labore elit officia children: -7796201 related: - extra: - day: '1973-09-13' octorateProductId: 28331531 price: 52858371.05080637 quantity: -44566067 reference: aute consectetur - day: '1988-12-07' octorateProductId: 65427572 price: 53022363.759127915 quantity: 95529165 reference: nisi children: -10862486 currency: currencyCode: id incididunt do dolore defaultFractionDigits: 44461268 numericCode: -84010043 displayName: deserunt dolore ipsum symbol: quis laboris numericCodeAsString: dolore veniam velit lang: JA portalId: labori internalRoom: -10937429 totalGross: -77589449.00905812 roomGross: -91035079.61337897 guest: address: Duis amet incididunt Excepteur country: elit est do incididunt eu email: anim city: ullamco minim dolore labore phone: voluptate adipisicing in anim zip: aliquip Lorem cillum firstName: proident Lorem lastName: quis et officia laborum reservationExternal: id: -18605868 channelId: Ut propertyId: ex proident mollit octorateId: mollit sint room: id dolor in ipsum propertyReference: in culpa infants: 54018624 externalRefer: pariatur l createDate: '1967-06-23T18:06:50.312Z' updateDate: '1985-11-17T14:13:50.942Z' api: false externalRoom: i internalRate: -83066520 portalNotes: in nulla dolor velit qui pmsRoom: quis paidStayTax: 81928919.95935705 paidNotes: est veniam i totalPaid: -70440394.96344703 conversationId: veniam irure cleaningFee: -62981266.59294714 totalCommissions: -96155716.12793486 companyCollect: HOTEl daily: - day: '2001-12-30T19:12:53.424Z' price: 26212445.084135845 - day: '1942-12-06T15:16:53.752Z' price: -87651355.546878 streamCard: activationDate: '1969-11-25T05:42:33.110Z' expirationDate: '1969-03-06T16:05:29.718Z' currentBalance: 50793243.165685534 isVirtual: false token: et irure empty: false json: {} paymentMode: TRAVELCHEQUE place: id: 27356853 placeType: ACCOMODATION address: commodo pariatur exercitation irure city: comm zipCode: qui deserunt country: ZM phone: in aute latitude: 26976337.042860672 longitude: -20279923.244849667 zoom: -18267744 codice: esse ipsum qui commodo districtName: fugiat dolor esse startDate: '1943-04-14T06:36:33.971Z' specialRequests: dolore officia ipsum exer endDate: '2012-11-30T16:30:59.415Z' pax: 59957498 refer: sint status: CANCELLED - extra: - day: '2017-03-04' octorateProductId: 6479987 price: -94194397.02271108 quantity: 69901245 reference: irure - day: '1992-01-20' octorateProductId: -58629307 price: -92548047.06198661 quantity: 84320484 reference: dolore consequat children: -6561724 currency: currencyCode: est dolore defaultFractionDigits: 13218287 numericCode: -78551435 displayName: dolore sunt nisi in symbol: labori numericCodeAsString: occaecat consequat lang: DE portalId: cupidata internalRoom: 41439857 totalGross: -57802706.21854742 roomGross: 19181535.636508018 guest: address: ut country: consequat occaecat tempor laborum email: proident pariatur nulla incididunt exercitation city: ullamco phone: nulla do zip: sunt quis dolore firstName: laborum lastName: in dolore nisi magna mollit reservationExternal: id: -24164995 channelId: officia adipisicing ipsum commodo propertyId: enim in magna octorateId: ullamco consequat anim room: sit ullamco nostrud irure propertyReference: Excepteur dolore exercitation aliquip infants: 91678044 externalRefer: sunt anim createDate: '1947-01-31T10:37:58.713Z' updateDate: '1964-03-19T13:46:17.045Z' api: false externalRoom: eu do et dolore internalRate: -98171121 portalNotes: laboris ad ullamco pmsRoom: dolore nulla et ipsum paidStayTax: 57975318.35698146 paidNotes: fugi totalPaid: -96726514.79057235 conversationId: fugiat cleaningFee: 57742381.169671685 totalCommissions: -71702611.46805315 companyCollect: HOTEl daily: - day: '1986-07-26T20:04:11.861Z' price: 28002943.06947376 - day: '1945-12-10T09:37:52.129Z' price: 41149150.43056935 streamCard: activationDate: '1969-09-08T22:15:42.812Z' expirationDate: '1955-02-21T22:47:40.047Z' currentBalance: -8015570.095736146 isVirtual: false token: Excepteur sunt fugiat minim empty: false json: {} paymentMode: UNKNOWN place: id: -54651458 placeType: ROOM address: est non adipisicing ad city: commodo deserunt zipCode: ullamco nulla qui cupidatat country: NE phone: enim id sunt latitude: -37089003.877104074 longitude: -88204370.08191791 zoom: -78985514 codice: est nisi districtName: sunt velit nostrud quis deserunt startDate: '1965-12-26T17:18:20.032Z' specialRequests: esse exer endDate: '1958-05-13T19:31:34.180Z' pax: 12584432 refer: non in anim officia tempor status: WAITING propertyReference: cupidatat dolore dolor infants: 35070726 internalRate: -19028931 companyCollect: NONE daily: - day: '1952-02-29T13:00:18.718Z' price: -42433803.06861964 - day: '1962-06-21T10:47:12.556Z' price: 43265339.69111946 streamCard: activationDate: '1947-10-25T03:53:41.638Z' expirationDate: '2008-08-04T02:43:13.346Z' currentBalance: 76973254.82536885 isVirtual: false token: ut aliqua dolor empty: true json: {} paymentMode: CHEQUE '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: 'Ut ' human_name: Invalid Json element: Reservation suggestion: est Ut nested: - message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: fugiat Ut aliquip repreh human_name: Invalid Json element: Reservation suggestion: ut Ut consectetur nisi nested: - value: >- - value: >- - message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: nostrud ea a human_name: Invalid Json element: Reservation suggestion: sunt est nested: - value: >- - value: >- '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: non eiusmod laboris human_name: Invalid Json element: Reservation suggestion: dolore non irure pariatur nested: - message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: esse volupta human_name: Invalid Json element: Reservation suggestion: mollit Excepteur nested: - value: >- - value: >- - message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: qui nisi veniam human_name: Invalid Json element: Reservation suggestion: officia sint qui tempor nested: - value: >- - value: >- '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: non eiusmod laboris human_name: Invalid Json element: Reservation suggestion: dolore non irure pariatur nested: - message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: esse volupta human_name: Invalid Json element: Reservation suggestion: mollit Excepteur nested: - value: >- - value: >- - message: 'Internal error: No enum constant Country.EN''' type: ApiParamsExemption machine_name: qui nisi veniam human_name: Invalid Json element: Reservation suggestion: officia sint qui tempor nested: - value: >- - value: >- /rest/v1/reservation/findReservationsNetwork: get: tags: - rest/v1 > Each User One Login > reservation summary: find Reservations Network description: 'Retrieve all reservations in a user a user network ' parameters: - name: refer in: query schema: type: string description: Reference of a group of reservations example: qui velit - name: type in: query schema: type: string description: >- Change the type of date search.
  • Some of the meaning of the allowed status: STAY (Accept interval, Period of stay)
  • Checkin/Checkout (Accept interval, Date of Checkin/out in that range)
  • CREATETIME(Accept interval, Time of creation)
  • MODIFIED ( Modified today )
  • NEWLY (Created in the last 3 days)
example: STAY - name: startDate in: query schema: type: string description: Date in format yyyy-MM-dd. Result depends on date type example: '1969-10-26' - name: endDate in: query schema: type: string description: Date in format yyyy-MM-dd. Result depends on date type example: '1969-10-26' - name: product in: query schema: type: number description: Filter by a typology or rate (product). Put here the ID example: '-22637726' - name: pmsProduct in: query schema: type: number description: Filter by a Pms Room (ID), like 102,103,104. Blue room, etc... example: '-22637726' - name: status in: query schema: type: string description: Filter by status example: CONFIRMED - name: size in: query schema: type: integer description: 'How many results per page? ' example: '20' - name: page in: query schema: type: integer description: Page number of the results example: '422' - name: excludedSources in: query schema: type: string description: Comma separated list of exluded sources example: qui velit responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 212 checkin: '1998-04-07T13:19:31.533Z' checkout: '1986-01-21T01:33:30.129Z' createTime: '1956-05-30T19:21:31.379Z' guests: - checkin: '1980-06-26' checkout: '1986-12-12' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1947-06-11' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: eiusmod enim address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1963-09-26' documentIssuePlace: Roma documentExpire: '2002-12-15T00:00:44.402Z' sex: MALE - checkin: '1972-02-06' checkout: '1975-07-05' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1943-06-02' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: et labor address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '2020-02-24' documentIssuePlace: Roma documentExpire: '1984-01-30T01:04:30.106Z' sex: MALE product: 1222222 refer: A2DD123_AA2211 status: CONFIRMED totalChildren: 0 totalGuest: 0 totalInfants: 0 updateTime: '1961-09-12T02:17:49.980Z' channelRefer: A12FF232DDDDDD pmsProduct: 1200122 roomGross: 47.56 channelNotes: Reservation payment facilitated through a virtual card privateNotes: >- Customer says is not sure whether will arrive on 25th or 26th of March, Payment was agreed but not yet arrived priceBreakdown: - type: DAILY_ROOM_PRICE createTime: '2008-04-10T07:00:33.394Z' day: '1996-12-30' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 33944167 included: false - type: DAILY_ROOM_PRICE createTime: '2001-11-07T19:07:43.396Z' day: '1958-11-09' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 10624519 included: true id: 123123 channelName: BOOKING currency: currencyCode: fugiat ut ut quis defaultFractionDigits: -73482270 numericCode: -26403502 displayName: Ut eiusmod irure symbol: elit commodo anim numericCodeAsString: exercitation touristTax: 12 paymentType: CREDITCARD paymentStatus: UNPAID freeCancellation: false paidCancellation: '2003-05-06T23:34:38.675Z' creditCard: token: a2uuy-uuyte-76433-hyt453-kkssst bank: ING DIRECT Bv. bankCountry: IT scheme: MASTERCARD activationDate: '2013-06-28T12:25:45.220Z' expireDate: '1994-04-08T13:27:52.576Z' lastUpdate: '2005-08-12T16:18:41.416Z' cvvAvailable: false cvvCleared: false cardUsed: false cardVirtual: true payments: - id: -56127074 insertTime: '1955-08-26T11:00:34.042Z' referenceTime: '1963-02-03T12:56:15.924Z' description: nulla aliquip paymentMode: CREDITCARD amount: -12937365.574373677 cityTaxAmount: 17884334.010387942 user: id: -135282 username: tempor ullamco in culpa firstname: ad in aliquip magna codpromo: labore ut ipsum codice: laborum sint quis deserunt labore type: USER scheduled: true scheduledTime: '1953-02-07T05:57:53.606Z' scheduledAmount: -92036134.19708799 - id: -46277909 insertTime: '1978-11-07T14:46:55.618Z' referenceTime: '2015-02-26T14:24:40.786Z' description: irure cupidatat fugiat paymentMode: CREDITCARD amount: 87324688.30332795 cityTaxAmount: -4032361.6976282448 user: id: 94851837 username: Lorem anim elit velit firstname: Ut ut codpromo: pariatur elit codice: cupidatat dolore type: ADMIN scheduled: false scheduledTime: '1969-08-14T10:08:15.275Z' scheduledAmount: -15304188.207770735 linkedReservations: - -57192556 - 75587101 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: aliqua eiusmod anim minim id: sit dstsavings: -70417523 rawOffset: 85525228 phoneNumber: Excepteur sed Ut aute dolor address: laboris adipisicing minim latitude: -82631170.96219333 longitude: 6846293.061984941 zipCode: commodo aute city: ipsum roomName: ut occaecat do roomNameGuest: nostrud ipsum guestsList: est Ut guestMailAddress: ut arrivalTime: ex amet split: splitRoom: id: 36452220 name: enim proiden splitAccommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: cillum id: cillum ad elit dstsavings: -10397929 rawOffset: -35222741 phoneNumber: ut sed in address: ut dolore minim cillum amet latitude: -67882608.26251987 longitude: 52765133.69408736 zipCode: fugiat nisi city: nostrud connection: id: 50591996 name: ea laborum splitStart: '1999-10-14' address: est do amet country: magna qui labore consectetur guest: address: consectetur country: sunt conse email: dolor nostrud elit city: labore phone: Duis culpa irure enim zip: culpa magna firstName: non in est Lorem lastName: reprehenderit incididunt consectetur sint proident reservationExternal: id: 37860786 channelId: sint do magna propertyId: repreh octorateId: ullamco tempor sit room: aliqua externalRefer: id api: true totalPaid: 60482471.921477824 conversationId: officia Ut ad cleaningFee: -60828494.92426212 place: id: 88344960 placeType: ROOM address: elit Excepteur city: qui tempor adipisicing zipCode: nostrud dolore consequat country: WS phone: ad latitude: -18677000.514493212 longitude: -60626748.74683358 zoom: 49282517 codice: dolor ea est veniam districtName: dolor city: proident zip: dolor sit do adipisicing extra: - day: '1955-09-17' octorateProductId: 59709117 price: -58404383.18974792 quantity: -94253733 reference: amet veniam sunt et Excepteur - day: '2003-09-07' octorateProductId: -37370826 price: 10066153.04357244 quantity: 31624864 reference: consequat sit labore elit officia children: -7796201 related: - extra: - day: '1973-09-13' octorateProductId: 28331531 price: 52858371.05080637 quantity: -44566067 reference: aute consectetur - day: '1988-12-07' octorateProductId: 65427572 price: 53022363.759127915 quantity: 95529165 reference: nisi children: -10862486 currency: currencyCode: id incididunt do dolore defaultFractionDigits: 44461268 numericCode: -84010043 displayName: deserunt dolore ipsum symbol: quis laboris numericCodeAsString: dolore veniam velit lang: JA portalId: labori internalRoom: -10937429 totalGross: -77589449.00905812 roomGross: -91035079.61337897 guest: address: Duis amet incididunt Excepteur country: elit est do incididunt eu email: anim city: ullamco minim dolore labore phone: voluptate adipisicing in anim zip: aliquip Lorem cillum firstName: proident Lorem lastName: quis et officia laborum reservationExternal: id: -18605868 channelId: Ut propertyId: ex proident mollit octorateId: mollit sint room: id dolor in ipsum propertyReference: in culpa infants: 54018624 externalRefer: pariatur l createDate: '1967-06-23T18:06:50.312Z' updateDate: '1985-11-17T14:13:50.942Z' api: false externalRoom: i internalRate: -83066520 portalNotes: in nulla dolor velit qui pmsRoom: quis paidStayTax: 81928919.95935705 paidNotes: est veniam i totalPaid: -70440394.96344703 conversationId: veniam irure cleaningFee: -62981266.59294714 totalCommissions: -96155716.12793486 companyCollect: HOTEl daily: - day: '2001-12-30T19:12:53.424Z' price: 26212445.084135845 - day: '1942-12-06T15:16:53.752Z' price: -87651355.546878 streamCard: activationDate: '1969-11-25T05:42:33.110Z' expirationDate: '1969-03-06T16:05:29.718Z' currentBalance: 50793243.165685534 isVirtual: false token: et irure empty: false json: {} paymentMode: TRAVELCHEQUE place: id: 27356853 placeType: ACCOMODATION address: commodo pariatur exercitation irure city: comm zipCode: qui deserunt country: ZM phone: in aute latitude: 26976337.042860672 longitude: -20279923.244849667 zoom: -18267744 codice: esse ipsum qui commodo districtName: fugiat dolor esse startDate: '1943-04-14T06:36:33.971Z' specialRequests: dolore officia ipsum exer endDate: '2012-11-30T16:30:59.415Z' pax: 59957498 refer: sint status: CANCELLED - extra: - day: '2017-03-04' octorateProductId: 6479987 price: -94194397.02271108 quantity: 69901245 reference: irure - day: '1992-01-20' octorateProductId: -58629307 price: -92548047.06198661 quantity: 84320484 reference: dolore consequat children: -6561724 currency: currencyCode: est dolore defaultFractionDigits: 13218287 numericCode: -78551435 displayName: dolore sunt nisi in symbol: labori numericCodeAsString: occaecat consequat lang: DE portalId: cupidata internalRoom: 41439857 totalGross: -57802706.21854742 roomGross: 19181535.636508018 guest: address: ut country: consequat occaecat tempor laborum email: proident pariatur nulla incididunt exercitation city: ullamco phone: nulla do zip: sunt quis dolore firstName: laborum lastName: in dolore nisi magna mollit reservationExternal: id: -24164995 channelId: officia adipisicing ipsum commodo propertyId: enim in magna octorateId: ullamco consequat anim room: sit ullamco nostrud irure propertyReference: Excepteur dolore exercitation aliquip infants: 91678044 externalRefer: sunt anim createDate: '1947-01-31T10:37:58.713Z' updateDate: '1964-03-19T13:46:17.045Z' api: false externalRoom: eu do et dolore internalRate: -98171121 portalNotes: laboris ad ullamco pmsRoom: dolore nulla et ipsum paidStayTax: 57975318.35698146 paidNotes: fugi totalPaid: -96726514.79057235 conversationId: fugiat cleaningFee: 57742381.169671685 totalCommissions: -71702611.46805315 companyCollect: HOTEl daily: - day: '1986-07-26T20:04:11.861Z' price: 28002943.06947376 - day: '1945-12-10T09:37:52.129Z' price: 41149150.43056935 streamCard: activationDate: '1969-09-08T22:15:42.812Z' expirationDate: '1955-02-21T22:47:40.047Z' currentBalance: -8015570.095736146 isVirtual: false token: Excepteur sunt fugiat minim empty: false json: {} paymentMode: UNKNOWN place: id: -54651458 placeType: ROOM address: est non adipisicing ad city: commodo deserunt zipCode: ullamco nulla qui cupidatat country: NE phone: enim id sunt latitude: -37089003.877104074 longitude: -88204370.08191791 zoom: -78985514 codice: est nisi districtName: sunt velit nostrud quis deserunt startDate: '1965-12-26T17:18:20.032Z' specialRequests: esse exer endDate: '1958-05-13T19:31:34.180Z' pax: 12584432 refer: non in anim officia tempor status: WAITING propertyReference: cupidatat dolore dolor infants: 35070726 internalRate: -19028931 companyCollect: NONE daily: - day: '1952-02-29T13:00:18.718Z' price: -42433803.06861964 - day: '1962-06-21T10:47:12.556Z' price: 43265339.69111946 streamCard: activationDate: '1947-10-25T03:53:41.638Z' expirationDate: '2008-08-04T02:43:13.346Z' currentBalance: 76973254.82536885 isVirtual: false token: ut aliqua dolor empty: true json: {} paymentMode: CHEQUE '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/reservation/: get: tags: - rest/v1 > Each User One Login > reservation summary: find Reservations by user description: 'Retrieve all reservations in a user a user network ' parameters: - name: size in: query schema: type: integer example: '20' - name: page in: query schema: type: integer example: '0' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: channelId: 212 checkin: '1998-04-07T13:19:31.533Z' checkout: '1986-01-21T01:33:30.129Z' createTime: '1956-05-30T19:21:31.379Z' guests: - checkin: '1980-06-26' checkout: '1986-12-12' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1947-06-11' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: eiusmod enim address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '1963-09-26' documentIssuePlace: Roma documentExpire: '2002-12-15T00:00:44.402Z' sex: MALE - checkin: '1972-02-06' checkout: '1975-07-05' familyName: Rossi givenName: Mario type: BOOKER id: 123123 accommodatedType: >- The first one will be automatically set as head of family, the others as relatives if null source: API birthDate: '1943-06-02' birthCountry: IT birthCity: ROMA residenceCountry: IT city: Roma email: myname@mycompany.com phone: et labor address: 15th Street, Manhattan, New York zipCode: '00022' language: IT nationality: IT documentCode: AS3332DC documentType: Passport documentIssueDate: '2020-02-24' documentIssuePlace: Roma documentExpire: '1984-01-30T01:04:30.106Z' sex: MALE product: 1222222 refer: A2DD123_AA2211 status: CONFIRMED totalChildren: 0 totalGuest: 0 totalInfants: 0 updateTime: '1961-09-12T02:17:49.980Z' channelRefer: A12FF232DDDDDD pmsProduct: 1200122 roomGross: 47.56 channelNotes: Reservation payment facilitated through a virtual card privateNotes: >- Customer says is not sure whether will arrive on 25th or 26th of March, Payment was agreed but not yet arrived priceBreakdown: - type: DAILY_ROOM_PRICE createTime: '2008-04-10T07:00:33.394Z' day: '1996-12-30' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 33944167 included: false - type: DAILY_ROOM_PRICE createTime: '2001-11-07T19:07:43.396Z' day: '1958-11-09' price: 122 name: Coffee reference: '12312312' product: 122122 quantity: 10624519 included: true id: 123123 channelName: BOOKING currency: currencyCode: fugiat ut ut quis defaultFractionDigits: -73482270 numericCode: -26403502 displayName: Ut eiusmod irure symbol: elit commodo anim numericCodeAsString: exercitation touristTax: 12 paymentType: CREDITCARD paymentStatus: UNPAID freeCancellation: false paidCancellation: '2003-05-06T23:34:38.675Z' creditCard: token: a2uuy-uuyte-76433-hyt453-kkssst bank: ING DIRECT Bv. bankCountry: IT scheme: MASTERCARD activationDate: '2013-06-28T12:25:45.220Z' expireDate: '1994-04-08T13:27:52.576Z' lastUpdate: '2005-08-12T16:18:41.416Z' cvvAvailable: false cvvCleared: false cardUsed: false cardVirtual: true payments: - id: -56127074 insertTime: '1955-08-26T11:00:34.042Z' referenceTime: '1963-02-03T12:56:15.924Z' description: nulla aliquip paymentMode: CREDITCARD amount: -12937365.574373677 cityTaxAmount: 17884334.010387942 user: id: -135282 username: tempor ullamco in culpa firstname: ad in aliquip magna codpromo: labore ut ipsum codice: laborum sint quis deserunt labore type: USER scheduled: true scheduledTime: '1953-02-07T05:57:53.606Z' scheduledAmount: -92036134.19708799 - id: -46277909 insertTime: '1978-11-07T14:46:55.618Z' referenceTime: '2015-02-26T14:24:40.786Z' description: irure cupidatat fugiat paymentMode: CREDITCARD amount: 87324688.30332795 cityTaxAmount: -4032361.6976282448 user: id: 94851837 username: Lorem anim elit velit firstname: Ut ut codpromo: pariatur elit codice: cupidatat dolore type: ADMIN scheduled: false scheduledTime: '1969-08-14T10:08:15.275Z' scheduledAmount: -15304188.207770735 linkedReservations: - -57192556 - 75587101 accommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: aliqua eiusmod anim minim id: sit dstsavings: -70417523 rawOffset: 85525228 phoneNumber: Excepteur sed Ut aute dolor address: laboris adipisicing minim latitude: -82631170.96219333 longitude: 6846293.061984941 zipCode: commodo aute city: ipsum roomName: ut occaecat do roomNameGuest: nostrud ipsum guestsList: est Ut guestMailAddress: ut arrivalTime: ex amet split: splitRoom: id: 36452220 name: enim proiden splitAccommodation: id: '16997' name: Manhattan Hotel currency: EUR timeZone: displayName: cillum id: cillum ad elit dstsavings: -10397929 rawOffset: -35222741 phoneNumber: ut sed in address: ut dolore minim cillum amet latitude: -67882608.26251987 longitude: 52765133.69408736 zipCode: fugiat nisi city: nostrud connection: id: 50591996 name: ea laborum splitStart: '1999-10-14' address: est do amet country: magna qui labore consectetur guest: address: consectetur country: sunt conse email: dolor nostrud elit city: labore phone: Duis culpa irure enim zip: culpa magna firstName: non in est Lorem lastName: reprehenderit incididunt consectetur sint proident reservationExternal: id: 37860786 channelId: sint do magna propertyId: repreh octorateId: ullamco tempor sit room: aliqua externalRefer: id api: true totalPaid: 60482471.921477824 conversationId: officia Ut ad cleaningFee: -60828494.92426212 place: id: 88344960 placeType: ROOM address: elit Excepteur city: qui tempor adipisicing zipCode: nostrud dolore consequat country: WS phone: ad latitude: -18677000.514493212 longitude: -60626748.74683358 zoom: 49282517 codice: dolor ea est veniam districtName: dolor city: proident zip: dolor sit do adipisicing extra: - day: '1955-09-17' octorateProductId: 59709117 price: -58404383.18974792 quantity: -94253733 reference: amet veniam sunt et Excepteur - day: '2003-09-07' octorateProductId: -37370826 price: 10066153.04357244 quantity: 31624864 reference: consequat sit labore elit officia children: -7796201 related: - extra: - day: '1973-09-13' octorateProductId: 28331531 price: 52858371.05080637 quantity: -44566067 reference: aute consectetur - day: '1988-12-07' octorateProductId: 65427572 price: 53022363.759127915 quantity: 95529165 reference: nisi children: -10862486 currency: currencyCode: id incididunt do dolore defaultFractionDigits: 44461268 numericCode: -84010043 displayName: deserunt dolore ipsum symbol: quis laboris numericCodeAsString: dolore veniam velit lang: JA portalId: labori internalRoom: -10937429 totalGross: -77589449.00905812 roomGross: -91035079.61337897 guest: address: Duis amet incididunt Excepteur country: elit est do incididunt eu email: anim city: ullamco minim dolore labore phone: voluptate adipisicing in anim zip: aliquip Lorem cillum firstName: proident Lorem lastName: quis et officia laborum reservationExternal: id: -18605868 channelId: Ut propertyId: ex proident mollit octorateId: mollit sint room: id dolor in ipsum propertyReference: in culpa infants: 54018624 externalRefer: pariatur l createDate: '1967-06-23T18:06:50.312Z' updateDate: '1985-11-17T14:13:50.942Z' api: false externalRoom: i internalRate: -83066520 portalNotes: in nulla dolor velit qui pmsRoom: quis paidStayTax: 81928919.95935705 paidNotes: est veniam i totalPaid: -70440394.96344703 conversationId: veniam irure cleaningFee: -62981266.59294714 totalCommissions: -96155716.12793486 companyCollect: HOTEl daily: - day: '2001-12-30T19:12:53.424Z' price: 26212445.084135845 - day: '1942-12-06T15:16:53.752Z' price: -87651355.546878 streamCard: activationDate: '1969-11-25T05:42:33.110Z' expirationDate: '1969-03-06T16:05:29.718Z' currentBalance: 50793243.165685534 isVirtual: false token: et irure empty: false json: {} paymentMode: TRAVELCHEQUE place: id: 27356853 placeType: ACCOMODATION address: commodo pariatur exercitation irure city: comm zipCode: qui deserunt country: ZM phone: in aute latitude: 26976337.042860672 longitude: -20279923.244849667 zoom: -18267744 codice: esse ipsum qui commodo districtName: fugiat dolor esse startDate: '1943-04-14T06:36:33.971Z' specialRequests: dolore officia ipsum exer endDate: '2012-11-30T16:30:59.415Z' pax: 59957498 refer: sint status: CANCELLED - extra: - day: '2017-03-04' octorateProductId: 6479987 price: -94194397.02271108 quantity: 69901245 reference: irure - day: '1992-01-20' octorateProductId: -58629307 price: -92548047.06198661 quantity: 84320484 reference: dolore consequat children: -6561724 currency: currencyCode: est dolore defaultFractionDigits: 13218287 numericCode: -78551435 displayName: dolore sunt nisi in symbol: labori numericCodeAsString: occaecat consequat lang: DE portalId: cupidata internalRoom: 41439857 totalGross: -57802706.21854742 roomGross: 19181535.636508018 guest: address: ut country: consequat occaecat tempor laborum email: proident pariatur nulla incididunt exercitation city: ullamco phone: nulla do zip: sunt quis dolore firstName: laborum lastName: in dolore nisi magna mollit reservationExternal: id: -24164995 channelId: officia adipisicing ipsum commodo propertyId: enim in magna octorateId: ullamco consequat anim room: sit ullamco nostrud irure propertyReference: Excepteur dolore exercitation aliquip infants: 91678044 externalRefer: sunt anim createDate: '1947-01-31T10:37:58.713Z' updateDate: '1964-03-19T13:46:17.045Z' api: false externalRoom: eu do et dolore internalRate: -98171121 portalNotes: laboris ad ullamco pmsRoom: dolore nulla et ipsum paidStayTax: 57975318.35698146 paidNotes: fugi totalPaid: -96726514.79057235 conversationId: fugiat cleaningFee: 57742381.169671685 totalCommissions: -71702611.46805315 companyCollect: HOTEl daily: - day: '1986-07-26T20:04:11.861Z' price: 28002943.06947376 - day: '1945-12-10T09:37:52.129Z' price: 41149150.43056935 streamCard: activationDate: '1969-09-08T22:15:42.812Z' expirationDate: '1955-02-21T22:47:40.047Z' currentBalance: -8015570.095736146 isVirtual: false token: Excepteur sunt fugiat minim empty: false json: {} paymentMode: UNKNOWN place: id: -54651458 placeType: ROOM address: est non adipisicing ad city: commodo deserunt zipCode: ullamco nulla qui cupidatat country: NE phone: enim id sunt latitude: -37089003.877104074 longitude: -88204370.08191791 zoom: -78985514 codice: est nisi districtName: sunt velit nostrud quis deserunt startDate: '1965-12-26T17:18:20.032Z' specialRequests: esse exer endDate: '1958-05-13T19:31:34.180Z' pax: 12584432 refer: non in anim officia tempor status: WAITING propertyReference: cupidatat dolore dolor infants: 35070726 internalRate: -19028931 companyCollect: NONE daily: - day: '1952-02-29T13:00:18.718Z' price: -42433803.06861964 - day: '1962-06-21T10:47:12.556Z' price: 43265339.69111946 streamCard: activationDate: '1947-10-25T03:53:41.638Z' expirationDate: '2008-08-04T02:43:13.346Z' currentBalance: 76973254.82536885 isVirtual: false token: ut aliqua dolor empty: true json: {} paymentMode: CHEQUE '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/invoice/187830: get: tags: - rest/v1 > Each User One Login > invoice summary: Read Invoices security: - bearerAuth: [] parameters: - name: Accept-Language in: header schema: type: string example: IT - name: reservations[] in: query schema: type: integer example: '101831447' - name: fields in: query schema: type: string example: id responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/affiliate/commissions: get: tags: - rest/v1 > Each User One Login > Affiliate summary: GET Affiliate document responses: '200': description: Successful response content: application/json: {} /rest/v1/payment/{propertyId}/register: post: tags: - rest/v1 > Each User One Login > Payment summary: Create Payment requestBody: content: {} parameters: - name: propertyId in: path schema: type: integer required: true example: '681002' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/payment/{accommodation}: get: tags: - rest/v1 > Each User One Login > Payment summary: Retrieve Payments parameters: - name: refer[] in: query schema: type: string example: SF4BI2 - name: accommodation in: path schema: type: integer required: true example: '656558' responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/portal: get: tags: - rest/v1 > Each User One Login > portal summary: Find All Available Portals responses: '200': description: Successful response content: application/json: {} /connect/rest/v1/tag/{accommodation}: get: tags: - rest/v1 > Each User One Login > Tags summary: Read Tags parameters: - name: accommodation in: path schema: type: integer required: true example: '16997' responses: '200': description: Successful response content: application/json: {} /rest/v1/subscription/{id}: put: tags: - rest/v1 > Api Admin Operation > subscription > {id} summary: update Subscription description: Update the current subscription requestBody: content: {} parameters: - name: url in: query schema: type: string example: qui velit - name: id in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' delete: tags: - rest/v1 > Api Admin Operation > subscription > {id} summary: delete Subscription description: Delete an existing subscription parameters: - name: id in: path schema: type: number required: true description: '(Required) ' example: '-22637726' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /rest/v1/subscription: get: tags: - rest/v1 > Api Admin Operation > subscription summary: retrieve Subscriptions description: Retrieve actived subscriptions responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /connect/rest/v1/subscription/{event}: post: tags: - rest/v1 > Api Admin Operation > subscription summary: create Subscription description: Create a new subscription requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: url: type: string example: http://localhost:8080 parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded - name: event in: path schema: type: string required: true description: '(Required) ' example: RESERVATION_CANCELLED responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: >- {"apiMember":000,"createTime":"2020-03-18T14:46:08.693Z[UTC]","endpoint":"ngrok.io/aaaaaaa","id":1,"type":"CONTENT_NOTIFICATION"} /rest/v1/subscription/list: get: tags: - rest/v1 > Api Admin Operation > subscription summary: list Subscriptions description: Retrieve the supported subscriptions responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /rest/v1/portal/apiportal: put: tags: - rest/v1 > Api Admin Operation > portal/apiportal summary: Update the API portal description: >- Some Application wants to receive ARI (Availability and rates inventory) from Octorate. In order to do it you should before create a new Portal inside the Octorate system. This call will update the current details. requestBody: content: '*/*': schema: type: string example: >- "{\n \"banner\": \"sint id laboris deserunt\",\n \"contentMetas\": [\n \"commodo quis culpa\",\n \"sint do sed\"\n ],\n \"externalName\": \"Booking.com\",\n \"internalName\": \"Your api name with underscore: i.e. my_api_name\",\n \"loginUrl\": \"myapp.com/backoffice/\",\n \"website\": \"www.booking.com\",\n \"calendarValues\": [\n \"CUTOFF\",\n \"AVAILABILITY\"\n ],\n \"colorHex\": \"c5c5c5\",\n \"logo\": \"To Write: https://www.mywebsite.com/myimage.jpg, In reading: 123432434234.jpg\"\n}" security: - apikeyAuth: [] parameters: - name: Content-Type in: header schema: type: string example: '*/*' responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' post: tags: - rest/v1 > Api Admin Operation > portal/apiportal summary: Create the API portal description: >- Some Application wants to receive ARI (Availability and rates inventory) from Octorate. In order to do it you should before create a new Portal inside the Octorate system requestBody: content: '*/*': schema: type: string example: >- "{\n \"banner\": \"eiusmod cillum in\",\n \"contentMetas\": [\n \"amet magna ipsum irure\",\n \"laboris commodo consectetur ut\"\n ],\n \"externalName\": \"Booking.com\",\n \"internalName\": \"Your api name with underscore: i.e. my_api_name\",\n \"loginUrl\": \"myapp.com/backoffice/\",\n \"website\": \"www.booking.com\",\n \"calendarValues\": [\n \"MINSTAY\",\n \"AVAILABILITY\"\n ],\n \"colorHex\": \"c5c5c5\",\n \"logo\": \"To Write: https://www.mywebsite.com/myimage.jpg, In reading: 123432434234.jpg\"\n}" security: - apikeyAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: '' /connect/rest/v1/identity/apilogin: post: tags: - rest/v1 > Api Admin Operation > identity summary: Admin Login description: >- Issue an access token, not related to any resource, in order to allow your application to create properties, handle them, create portals inside Octorate or create new webhook subscription.
If you want to use this authentication method we expect you to NOT access any data related to the properties whereas every single user must grant you the authorization. (If you need check the OAuth tutorial) requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: client_id: type: string description: The client_id is a public identifier for apps example: c8b11a57e63a454e93e52e3ac208aad3 client_secret: type: string description: >- The client_secret is a secret known only to the application and octorate It is critical that developers never include their client_secret in public (mobile or browser-based) apps. example: '{{octorate_client_secret}}' my_note: type: string example: devin security: - noauthAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: access_token: magna Ut refresh_token: nisi elit et Lorem officia expireDate: '1958-11-02T08:20:37.927Z' token_type: do aute sit '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /rest/v1/identity/migrate: post: tags: - rest/v1 > Api Admin Operation > identity summary: Migrate Old description: >- Migrate the old Api Key to a new Access + Refresh Token. Can be execute once, it will NOT invalidate your api key for the old api system requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: accommodation: type: string example: anim do Duis parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '500': description: Internal Server Error headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: access_token: magna Ut refresh_token: nisi elit et Lorem officia expireDate: '1958-11-02T08:20:37.927Z' token_type: do aute sit /connect/rest/v1/identity/refresh: post: tags: - rest/v1 > Api Admin Operation > identity summary: refresh description: Refresh the current token requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: client_id: type: string description: The client_id is a public identifier for apps example: '{{octorate_client_id}}' client_secret: type: string example: '{{octorate_client_secret}}' refresh_token: type: string description: >- The previously granted refresh token. If you don't know what's this or where recover it check the authentication tutorial example: d2c36f2c842942b88ba52d1f55f4d4e3JM parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object examples: example-0: summary: Token issued value: access_token: >- 01a83320-1c11-42f4-ab8e-8dd3d98af1132d7846ec-bd32-4b51-9a49-d394202bbb30 expireDate: '2020-06-17T10:22:30.000Z' example-1: summary: refresh value: accessToken: a68ce097929c4880bdde7c6905f9f15eOGUAXDLHHE access_token: a68ce097929c4880bdde7c6905f9f15eOGUAXDLHHE expireDate: 2023-08-02T13:00:30.176Z[UTC] '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/identity/token: post: tags: - rest/v1 > Api Admin Operation > identity summary: Properties Token description: >- This method interest you if you want to access the data of the properties. So reading reservations, writing new rooms, and reading content are part of this authentication scheme. In this case the authentication is granular and for each user. We expect that the single user gives you the authorization to proceed. In case you're creating a new property you don't need this api method but you will find it inside the response of created accommodation.
We expect that the user has granted the authorization to proceed to connect your api.
After that we have redirect the user back to your site (Redirect_uri) appending as url param the value code.
Consume here the previously provided one shoot grant and retrieve the token. You have 3 minutes to consume the grant after you will have to ask again the authorization requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: client_id: type: string description: The client_id is a public identifier for apps example: '{{octorate_client_id}}' client_secret: type: string description: >- The client_secret is a secret known only to the application and octorate It is critical that developers never include their client_secret in public (mobile or browser-based) apps. example: '{{octorate_client_secret}}' code: type: string description: >- Once the user has been redirect back to your site, you will find this param in the url (GET PARAMS). Please at this stage use 'code'' example: >- d8aa35aa26614c6bb8cded2a9f89f7496618dae920c14a31b3afaa09cea95852 grant_type: type: string description: please use 'code' example: code redirect_uri: type: string description: >- Should be whitelisted by octorate. Use always the same through the same flow example: https://v2.brainyrms.com/SignInPage security: - noauthAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: access_token: magna Ut refresh_token: nisi elit et Lorem officia expireDate: '1958-11-02T08:20:37.927Z' token_type: do aute sit '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '403': description: Forbidden headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /connect/rest/v1/api/configuration: get: tags: - rest/v1 > Api Admin Operation > api/configuration summary: Read Configuration description: >- Retrieve the current configuration. Use this method to
  • Check your current redirect uri
  • Setup information like your name, category or icon
  • Check your configuration: i.e. licence, allowed permissions, if you are in sandbox mode, if you have any reseller account linked
parameters: - name: '' in: query schema: type: string responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: environment: cillum redirectUri: - dolore labore - dolor category: RMS icon: do ex secretVisibility: false applicationName: My Awesome application description: EN: These are the LanguageMap value in English! active: true authMethod: 'tempor aliqua cupidatat ' authorizationPages: - ad - eu labore quotaLimit: -58399167 quotaStatus: 5154979 reseller: reseller: true permUpgrade: false permOwners: true resellerName: d resellerEmail: consequat minim irure codPromo: culpa fugiat exercitat permissions: accommodation: READONLY license: READONLY cardDetail: READONLY content: READONLY reservation: NONE /rest/v1/api/configuration: patch: tags: - rest/v1 > Api Admin Operation > api/configuration summary: Write Configuration description: >- Setup your api options, you can either specify one of requested fields or all of them, we will process only the changed one.
Ideally, you should to this step at least the first time requestBody: content: '*/*': schema: type: string example: >- "{\n \"environment\": \"ullamco ad\",\n \"redirectUri\": [\n \"pariatur s\",\n \"dolor\"\n ],\n \"category\": \"OTA\",\n \"icon\": \"tempor ex nulla\",\n \"secretVisibility\": true,\n \"applicationName\": \"My Awesome application\",\n \"description\": {\n \"EN\": \"These are the LanguageMap value in English!\"\n }\n}" security: - apikeyAuth: [] parameters: - name: Content-Type in: header schema: type: string example: '*/*' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: environment: in consequat velit redirectUri: - eiusmod quis sit - magna dolor category: RMS icon: sed reprehenderit quis adipisicing secretVisibility: true applicationName: My Awesome application description: EN: These are the LanguageMap value in English! active: false authMethod: dolor deserunt Excepteur p authorizationPages: - sunt sint Ut qui - nisi consectetur dolor quotaLimit: -26677039 quotaStatus: 43183004 reseller: reseller: false permUpgrade: false permOwners: false resellerName: cupidatat anim enim resellerEmail: cupidatat codPromo: dolor laboris permissions: accommodation: NONE license: READWRITE cardDetail: NONE content: READONLY reservation: NONE /rest/v1/accommodation: get: tags: - rest/v1 > Api Admin Operation > accommodation summary: retrieve Accommodations Copy description: >- Find accommodations created or attached. Response will vary according to the security provided (All the properties with ApiOperations, Only token properties with OAuthLogin) security: - oauth2Auth: [] parameters: - name: page in: query schema: type: number description: The page number example: '-22637726' - name: name in: query schema: type: string description: Name of accommodation or codice (contains) example: qui velit - name: mail in: query schema: type: string description: Mail to filter (exact match) example: qui velit responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - currency: EUR id: '47260' name: Silvia Test Api Master timeZone: Europe/Rome contact: email: tech@dormoa.com familyName: Silvia givenName: Silvia mobileNumber: '' mobilePrefix: 39 location: city: Roma country: IT districtName: '' latitude: 0 longitude: 0 zipCode: '' zoom: 13 networkActive: true networkInfo: accessEnabled: true accessNetwork: '314142' accessRoot: true propertyCategory: OTHER - currency: EUR id: '314142' name: Silvia Test Api timeZone: Europe/Rome contact: email: tech@dormoa.com familyName: Silvia givenName: Silvia mobileNumber: '' mobilePrefix: 39 location: city: Roma country: IT districtName: '' latitude: 0 longitude: 0 zipCode: '' zoom: 13 networkActive: true networkInfo: accessEnabled: true accessNetwork: '314142' accessRoot: false propertyCategory: OTHER - currency: EUR id: '450020' name: Silvia Test Api Account 2 timeZone: Europe/Rome contact: email: tech@dormoa.com familyName: Silvia givenName: Silvia mobileNumber: '' mobilePrefix: 39 location: city: Roma country: IT districtName: '' latitude: 0 longitude: 0 zipCode: '' zoom: 13 networkActive: true networkInfo: accessEnabled: true accessNetwork: '314142' accessRoot: false propertyCategory: OTHER /connect/rest/v2/accommodation: post: tags: - rest/v1 > Api Admin Operation > accommodation summary: Add new Accommodation requestBody: content: application/json: schema: type: object example: zip: '00055' city: Ladispoli givenName: Property Owner Name familyName: Property Owner LastName name: Octorate Test Property at Ladispoli timeZone: Europe/Rome latitude: 41.953197695567674 longitude: 12.080973077154129 currency: EUR email: devin+12@octorate.com propertyCategory: APARTMENT cleaningCost: 5 breakfastIncluded: true breakfastPrice: 5 accept_duplicates: true country: IT location: placeType: ACCOMODATION address: Viale Italia 1 city: Ladispoli zipCode: '00055' country: IT latitude: 41.953197695567674 longitude: 12.080973077154129 zoom: 13 contact: phoneNumber: '+393347608861' email: devin+12@octorate.com givenName: Devin familyName: Octorate license: channelManager: PREMIUM expireDay: 2030-01-01T00:00 checkinStart: 11 checkinEnd: 14 checkout: 10 responses: '200': description: Successful response content: application/json: {} /rest/v1/accommodation/{property}: patch: tags: - rest/v1 > Api Admin Operation summary: info description: Retrieve information about an user requestBody: content: application/json: schema: type: object example: address: Boulevard du Lac city: CHAMBON SUR LAC currency: EUR id: '193476' name: ARVERNHA RESORTS Master phoneNumber: 04 73 88 66 46 timeZone: Europe/Paris zipCode: '63790' contact: email: support@homeresa.com familyName: ARVERNHA RESORTS givenName: CHAMBON mobileNumber: '' mobilePrefix: '+33' phoneNumber: 04 73 88 66 46 license: bookingEngine: true channelManager: PREMIUM chat: false expireDay: 2099-12-09T23:00:00Z[UTC] fiscalPrinter: false octoDaily: false octoSite: true realPlanning: true rms: false smartOffer: true webConcierge: true latitude: 45.57913223840124 longitude: 2.8668363001086417 location: address: Boulevard du Lac city: CHAMBON SUR LAC country: FR districtName: '' latitude: 45.57913223840124 longitude: 2.8668363001086417 phone: 04 73 88 66 46 zipCode: '63790' zoom: 13 networkActive: true networkInfo: accessEnabled: true accessNetwork: '611143' accessRoot: true propertyCategory: OTHER security: - oauth2Auth: [] parameters: - name: property in: path schema: type: integer required: true example: '193476' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: name: John Snow email: mymail@test.it username: octo_john /connect/rest/v2/reservation/{accommodation}: get: tags: - rest/v2 [Experimental] > Each User One Login > reservation summary: Retrieve Reservations parameters: - name: type in: query schema: type: string example: ACTIVE - name: size in: query schema: type: integer example: '50' - name: source in: query schema: type: string example: octoevo - name: refer in: query schema: type: string example: NJ9RF5 - name: accommodation in: path schema: type: integer required: true example: '656558' responses: '200': description: Successful response content: application/json: {} put: tags: - rest/v2 [Experimental] > Each User One Login > reservation summary: Create Reservations requestBody: content: application/json: schema: type: object example: data: - accommodation: currency: EUR id: '917193' name: Hotel Kursaal booker: checkin: '2023-09-07' checkout: '2023-09-10' city: '' email: devin@octorate.com familyName: Last Name of Octorate Test givenName: Given Name of Octorate Test language: IT phone: '+39330987632' source: USER type: BOOKER zipCode: '' breakfast: true channelId: 288 channelName: octoevo autosubmit channelRefer: AAAA1 checkin: 2023-10-07T22:00:00Z[UTC] checkout: 2023-10-09T22:00:00Z[UTC] currency: EUR days: - day: '2023-10-07T22:00:00+00:00' price: 1 ratePlanCorrection: 0 - day: '2023-10-08T22:00:00+00:00' price: 2 ratePlanCorrection: 0 reservationId: 103306934 - day: '2023-10-09T22:00:00+00:00' price: 3 ratePlanCorrection: 0 extras: [] grouped: false guests: [] housekeepingNotes: '' itemCompleted: false noShow: false paymentType: CREDITCARD payments: [] pmsProduct: 347817 privateNotes: Sto prevando una prenotazione di prova product: 340534 ratePlan: 24 ratePlanPrice: 0 refer: AAAAAA roomGross: 1 rooms: 1 status: CONFIRMED totalChildren: 0 totalGross: 1 totalGuest: 3 totalInfants: 0 totalPaid: 0 touristTax: 0 parameters: - name: accommodation in: path schema: type: integer required: true example: '917193' responses: '200': description: Successful response content: application/json: {} /connect/rest/v2/reservation/{accommodation}/synchronize: post: tags: - rest/v2 [Experimental] > Each User One Login > reservation summary: Sync Resa Front-Back >0 requestBody: content: application/json: schema: type: object example: data: - id: 103990395 totalGross: 0 booker: customerName: Parker Peter givenName: Peter familyName: Parker email: '' phone: '' language: IT address: null city: null zipCode: null nationality: null checkin: '2023-09-01T22:00:00.000Z' checkout: '2023-09-05T22:00:00.000Z' totalGuest: 1 totalChildren: 0 totalInfants: 0 roomName: Camera Doppia comunicante product: 515430 pmsProduct: 511181 ratePlan: null ratePlanPrice: 0 days: - title: 02/09/2023 subtitle: '' day: '2023-09-01T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: 0 - title: 03/09/2023 subtitle: '' day: '2023-09-02T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: 0 - title: 04/09/2023 subtitle: '' day: '2023-09-03T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: 0 - title: 05/09/2023 subtitle: '' day: '2023-09-04T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: 0 - title: 2023/09/06 subtitle: null day: '2023-09-05T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: null - title: 2023/09/07 subtitle: null day: '2023-09-06T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: null - title: 2023/09/08 subtitle: null day: '2023-09-07T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: null - title: 2023/09/09 subtitle: null day: '2023-09-08T22:00:00.000Z' price: 0 priceDiscount: null ratePlanCorrection: null extras: [] channelNotes: null noteTime: true privateNotes: null housekeepingNotes: null parameters: - name: Accept-Language in: header schema: type: string example: IT - name: accommodation in: path schema: type: integer required: true example: '917193' responses: '200': description: OK headers: Server: schema: type: string example: 'Payara Server 6.2023.7 #badassfish' X-Powered-By: schema: type: string example: >- Servlet/6.0 JSP/3.1 (Payara Server 6.2023.7 #badassfish Java/Oracle Corporation/17) Access-Control-Allow-Origin: schema: type: string example: http://localhost:4200 Access-Control-Allow-Methods: schema: type: string example: PATCH, PUT, DELETE Access-Control-Allow-Headers: schema: type: string example: Origin, X-Requested-With, Content-Type, Accept, Authorization Access-Control-Allow-Credentials: schema: type: boolean example: 'true' Content-Security-Policy: schema: type: string example: frame-ancestors http://localhost:4200 http://localhost:8080 request-id: schema: type: string example: 6603ffd6-058e-4366-b5df-aaffb4944eef X-RateLimit-Remaining: schema: type: integer example: '268' X-RateLimit-Remaining-656558: schema: type: integer example: '268' Content-Type: schema: type: string example: application/json Content-Length: schema: type: integer example: '1246' X-Frame-Options: schema: type: string example: SAMEORIGIN content: application/json: schema: type: object example: data: - arrivalTime: '' days: - id: 60193318 price: 9999 ratePlanCorrection: 0 reservationId: 103735499 subtitle: '' title: '' - id: 60193319 price: 9999 ratePlanCorrection: 0 reservationId: 103735499 subtitle: '' title: '' - id: 60193320 price: 9999 ratePlanCorrection: 0 reservationId: 103735499 subtitle: '' title: '' - id: 60193321 price: 9999 ratePlanCorrection: 0 reservationId: 103735499 subtitle: '' title: '' - day: '2023-08-08T00:00:00' id: 60193317 price: 9999 priceDiscount: 8699.13 ratePlanCorrection: 0 reservationId: 103735499 subtitle: '' title: '2023-08-08' - day: '2023-08-08T00:00:00' id: 60193322 price: 9999 ratePlanCorrection: 0 reservationId: 103735499 subtitle: '' title: '2023-08-08' - day: '2023-08-08T00:00:00' id: 60193323 price: 9999 ratePlanCorrection: 0 reservationId: 103735499 subtitle: '' title: '2023-08-08' - day: '2023-08-11T00:00:00' price: 8 ratePlanCorrection: 1 reservationId: 103735499 subtitle: '' title: '2023-08-11' extras: [] freeCancellation: false grouped: false guests: [] itemCompleted: false noShow: false noteTime: false rooms: 1 status: CONFIRMED totalGuest: 0 touristTax: 0 /connect/rest/v2/reservation/{accommodation}/{refer}/link: post: tags: - rest/v2 [Experimental] > Each User One Login > reservation summary: Link Reservation requestBody: content: {} parameters: - name: reservationRefers[] in: query schema: type: string example: DM3ZW9 - name: accommodation in: path schema: type: integer required: true example: '656558' - name: refer in: path schema: type: string required: true example: NQ0RS2 responses: '200': description: Successful response content: application/json: {} /connect/rest/v2/reservation/{accommodation}/{refer}/unlink: post: tags: - rest/v2 [Experimental] > Each User One Login > reservation summary: UnLink Reservation requestBody: content: {} parameters: - name: reservationRoomIds[] in: query schema: type: integer example: '105904880' - name: accommodation in: path schema: type: integer required: true example: '656558' - name: refer in: path schema: type: string required: true example: NQ0RS2 responses: '200': description: Successful response content: application/json: {} /connect/rest/v2/payment/{propertyId}/{refer}: post: tags: - rest/v2 [Experimental] > Each User One Login > payment summary: Create Payment Resa requestBody: content: application/json: schema: type: object example: amount: 23 description: test devin date: '2023-10-11' paymentMode: CREDITCARD parameters: - name: propertyId in: path schema: type: integer required: true example: '656558' - name: refer in: path schema: type: string required: true example: SF4BI2 responses: '200': description: Successful response content: application/json: {} /connect/rest/v2/payment/{propertyId}/{refer}/CHARGE: post: tags: - rest/v2 [Experimental] > Each User One Login > payment summary: Create Payment Resa Charge requestBody: content: application/json: schema: type: object example: source: PRIVATE paymentMode: CREDITCARD referenceTime: '2023-10-26T10:02:22.845Z' cityTaxAmount: 1 amount: 100 scheduledPaid: false description: test user: id: 21367 parameters: - name: propertyId in: path schema: type: integer required: true example: '656558' - name: refer in: path schema: type: string required: true example: SF4BI2 responses: '200': description: Successful response content: application/json: {} /connect/rest/v2/invoice/656558: get: tags: - rest/v2 [Experimental] > Each User One Login > invoices summary: GET (InvoiceRequest) parameters: - name: dateType in: query schema: type: string example: THIS_YEAR - name: documentTypes[] in: query schema: type: string example: PROFORMA - name: passive in: query schema: type: boolean example: 'false' - name: page in: query schema: type: integer example: '0' - name: size in: query schema: type: integer example: '200' - name: fields in: query schema: type: string example: >- id,type,givenName,familyName,paymentStatus,protocol,total,totalPaid,date,cancelDate,depositStatus,reservations,items,propertyId,fiscalStatus,passive responses: '200': description: Successful response content: application/json: {}