· 4 years ago · Apr 06, 2021, 10:52 AM
1{
2 "openapi": "3.0.0",
3 "info": {
4 "title": "Toolfactory.Suppliers.Transfers.App",
5 "version": "v1"
6 },
7 "servers": [
8 {
9 "url": "http://transfers.suppliers.integration.hub.pro.logitravel.internal"
10 }
11 ],
12 "paths": {
13 "/product/availability": {
14 "post": {
15 "tags": [
16 "product"
17 ],
18 "summary": "Gets available product for the given dates, locations, and passenger specifications.",
19 "description": "Gets available product for the given dates, locations, and passenger specifications.",
20 "operationId": "product_availability",
21 "requestBody": {
22 "content": {
23 "application/json": {
24 "schema": {
25 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Availability.AvailabilityRequest"
26 }
27 }
28 },
29 "required": true
30 },
31 "responses": {
32 "200": {
33 "description": "Availability response.",
34 "content": {
35 "application/json": {
36 "schema": {
37 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Availability.AvailabilityResponse"
38 }
39 }
40 }
41 },
42 "400": {
43 "description": "Bad input parameter.",
44 "content": {
45 "application/json": {
46 "schema": {
47 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
48 }
49 }
50 }
51 },
52 "401": {
53 "description": "Unauthorized. Verify api key.",
54 "content": {
55 "application/json": {
56 "schema": {
57 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
58 }
59 }
60 }
61 },
62 "404": {
63 "description": "Product not exists.",
64 "content": {
65 "application/json": {
66 "schema": {
67 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
68 }
69 }
70 }
71 },
72 "500": {
73 "description": "Internal server error.",
74 "content": {
75 "application/json": {
76 "schema": {
77 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
78 }
79 }
80 }
81 }
82 }
83 }
84 },
85 "/product/quote": {
86 "post": {
87 "tags": [
88 "product"
89 ],
90 "summary": "Quotes a product obtained in the availability transaction.",
91 "description": "Quotes a product obtained in the availability transaction.",
92 "operationId": "product_quote",
93 "requestBody": {
94 "content": {
95 "application/json": {
96 "schema": {
97 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Quote.QuoteRequest"
98 }
99 }
100 },
101 "required": true
102 },
103 "responses": {
104 "200": {
105 "description": "Quote response.",
106 "content": {
107 "application/json": {
108 "schema": {
109 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Quote.QuoteResponse"
110 }
111 }
112 }
113 },
114 "400": {
115 "description": "Bad input parameter.",
116 "content": {
117 "application/json": {
118 "schema": {
119 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
120 }
121 }
122 }
123 },
124 "401": {
125 "description": "Unauthorized. Verify api key.",
126 "content": {
127 "application/json": {
128 "schema": {
129 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
130 }
131 }
132 }
133 },
134 "404": {
135 "description": "Product not exists.",
136 "content": {
137 "application/json": {
138 "schema": {
139 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
140 }
141 }
142 }
143 },
144 "500": {
145 "description": "Internal server error.",
146 "content": {
147 "application/json": {
148 "schema": {
149 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
150 }
151 }
152 }
153 }
154 }
155 }
156 },
157 "/product/confirm": {
158 "post": {
159 "tags": [
160 "product"
161 ],
162 "summary": "Confirms the purchase of a product. Quotation of the product is mandatory before confirmation.",
163 "description": "Confirms the purchase of a product. Quotation of the product is mandatory before confirmation.",
164 "operationId": "product_confirm",
165 "requestBody": {
166 "content": {
167 "application/json": {
168 "schema": {
169 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Confirm.ConfirmRequest"
170 }
171 }
172 },
173 "required": true
174 },
175 "responses": {
176 "200": {
177 "description": "Confirm response.",
178 "content": {
179 "application/json": {
180 "schema": {
181 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Confirm.ConfirmResponse"
182 }
183 }
184 }
185 },
186 "400": {
187 "description": "Bad input parameter.",
188 "content": {
189 "application/json": {
190 "schema": {
191 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
192 }
193 }
194 }
195 },
196 "401": {
197 "description": "Unauthorized. Verify api key.",
198 "content": {
199 "application/json": {
200 "schema": {
201 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
202 }
203 }
204 }
205 },
206 "404": {
207 "description": "Product not exists.",
208 "content": {
209 "application/json": {
210 "schema": {
211 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
212 }
213 }
214 }
215 },
216 "500": {
217 "description": "Internal server error.",
218 "content": {
219 "application/json": {
220 "schema": {
221 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
222 }
223 }
224 }
225 }
226 }
227 }
228 },
229 "/booking/info/{locator}": {
230 "get": {
231 "tags": [
232 "booking"
233 ],
234 "summary": "Gets information about a confirmed service from a given booking code.",
235 "description": "Gets information about a confirmed service from a given booking code.",
236 "operationId": "booking_info",
237 "parameters": [
238 {
239 "name": "locator",
240 "in": "path",
241 "description": "Booking locator.",
242 "required": true,
243 "style": "simple",
244 "explode": false,
245 "schema": {
246 "type": "string"
247 }
248 }
249 ],
250 "responses": {
251 "200": {
252 "description": "Booking info response.",
253 "content": {
254 "application/json": {
255 "schema": {
256 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Booking.Info.InfoResponse"
257 }
258 }
259 }
260 },
261 "400": {
262 "description": "Bad input parameter.",
263 "content": {
264 "application/json": {
265 "schema": {
266 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
267 }
268 }
269 }
270 },
271 "401": {
272 "description": "Unauthorized. Verify api key.",
273 "content": {
274 "application/json": {
275 "schema": {
276 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
277 }
278 }
279 }
280 },
281 "404": {
282 "description": "Product not exists.",
283 "content": {
284 "application/json": {
285 "schema": {
286 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
287 }
288 }
289 }
290 },
291 "500": {
292 "description": "Internal server error.",
293 "content": {
294 "application/json": {
295 "schema": {
296 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
297 }
298 }
299 }
300 }
301 }
302 }
303 },
304 "/booking/cancel/{locator}": {
305 "get": {
306 "tags": [
307 "booking"
308 ],
309 "summary": "Requests the cancellation of a service from a given booking code.",
310 "description": "Requests the cancellation of a service from a given booking code.",
311 "operationId": "booking_cancel",
312 "parameters": [
313 {
314 "name": "locator",
315 "in": "path",
316 "description": "Booking locator.",
317 "required": true,
318 "style": "simple",
319 "explode": false,
320 "schema": {
321 "type": "string"
322 }
323 }
324 ],
325 "responses": {
326 "200": {
327 "description": "Cancel response.",
328 "content": {
329 "application/json": {
330 "schema": {
331 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Booking.Cancel.CancelResponse"
332 }
333 }
334 }
335 },
336 "400": {
337 "description": "Bad input parameter.",
338 "content": {
339 "application/json": {
340 "schema": {
341 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
342 }
343 }
344 }
345 },
346 "401": {
347 "description": "Unauthorized. Verify api key.",
348 "content": {
349 "application/json": {
350 "schema": {
351 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
352 }
353 }
354 }
355 },
356 "404": {
357 "description": "Product not exists.",
358 "content": {
359 "application/json": {
360 "schema": {
361 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
362 }
363 }
364 }
365 },
366 "500": {
367 "description": "Internal server error.",
368 "content": {
369 "application/json": {
370 "schema": {
371 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error"
372 }
373 }
374 }
375 }
376 }
377 }
378 }
379 },
380 "components": {
381 "schemas": {
382 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Availability.AvailabilityRequest": {
383 "properties": {
384 "preferences": {
385 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Preferences"
386 },
387 "segments": {
388 "type": "array",
389 "items": {
390 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Segment"
391 }
392 },
393 "passengers": {
394 "type": "array",
395 "items": {
396 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Passenger"
397 }
398 }
399 },
400 "description": "Parameters for a product availability."
401 },
402 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Availability.AvailabilityResponse": {
403 "properties": {
404 "id": {
405 "type": "string",
406 "description": "Availability ID.\nThis value will be needed in further operations.\n"
407 },
408 "transfers": {
409 "type": "array",
410 "description": "Information about the operating transfers.",
411 "items": {
412 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Transfer"
413 }
414 },
415 "rates": {
416 "type": "array",
417 "description": "Information about the operating transfers rates.",
418 "items": {
419 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Rate"
420 }
421 },
422 "warnings": {
423 "type": "array",
424 "description": "Includes detail about an unexpected event.",
425 "items": {
426 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.WarningEvent"
427 }
428 },
429 "audit": {
430 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Audit"
431 }
432 },
433 "description": "Result of a valid availability operation."
434 },
435 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Quote.QuoteRequest": {
436 "properties": {
437 "availability_id": {
438 "description": "ID of the availability response that contains the rates to be quoted."
439 },
440 "rates": {
441 "type": "array",
442 "description": "IDs of the rates that have to be quoted.",
443 "items": {
444 "type": "integer"
445 }
446 }
447 },
448 "description": "Parameters for a product quotation."
449 },
450 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Quote.QuoteResponse": {
451 "properties": {
452 "id": {
453 "type": "string",
454 "description": "Quote ID.\nThis value will be needed in further operations.\n"
455 },
456 "passengers": {
457 "type": "array",
458 "items": {
459 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Passenger"
460 }
461 },
462 "rates": {
463 "type": "array",
464 "description": "Quoted transfer rates.",
465 "items": {
466 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.SelectedRate"
467 }
468 },
469 "price_breakdown": {
470 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PriceBreakdown"
471 },
472 "warnings": {
473 "type": "array",
474 "description": "Includes detail about an unexpected event.",
475 "items": {
476 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.WarningEvent"
477 }
478 },
479 "audit": {
480 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Audit"
481 }
482 },
483 "description": "Result of a valid quote operation."
484 },
485 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Confirm.ConfirmRequest": {
486 "properties": {
487 "quote_id": {
488 "type": "string",
489 "description": "The ID of the previous quote."
490 },
491 "passengers": {
492 "type": "array",
493 "description": "Completed data of the passengers.",
494 "items": {
495 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PassengerConfirm"
496 }
497 },
498 "customer": {
499 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Customer"
500 },
501 "delta_price": {
502 "type": "number",
503 "format": "double"
504 }
505 },
506 "description": "Parameters to confirm the purchase of a product."
507 },
508 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Confirm.ConfirmResponse": {
509 "properties": {
510 "locator": {
511 "type": "string",
512 "description": "The reference for the booking."
513 },
514 "status": {
515 "type": "integer",
516 "format": "int32",
517 "enum": [
518 0,
519 1,
520 2,
521 3
522 ]
523 },
524 "rates": {
525 "type": "array",
526 "description": "Confirmed transfer rates.",
527 "items": {
528 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.SelectedRate"
529 }
530 },
531 "price_breakdown": {
532 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PriceBreakdown"
533 },
534 "vouchers": {
535 "type": "array",
536 "description": "Documentation that has to be to be attached to the booking and sent to the booking holder.",
537 "items": {
538 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.UrlResource"
539 }
540 },
541 "warnings": {
542 "type": "array",
543 "description": "Includes detail about an unexpected event.",
544 "items": {
545 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.WarningEvent"
546 }
547 },
548 "audit": {
549 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Audit"
550 }
551 },
552 "description": "Result of a valid confirmation."
553 },
554 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Booking.Info.InfoResponse": {
555 "properties": {
556 "booking_date": {
557 "type": "string",
558 "format": "date-time"
559 },
560 "locator": {
561 "type": "string"
562 },
563 "rates": {
564 "type": "array",
565 "items": {
566 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.SelectedRate"
567 }
568 },
569 "passengers": {
570 "type": "array",
571 "items": {
572 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PassengerConfirm"
573 }
574 },
575 "customer": {
576 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Customer"
577 },
578 "cancellation_penalty": {
579 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price"
580 },
581 "status": {
582 "type": "integer",
583 "enum": [
584 0,
585 1,
586 2,
587 3
588 ]
589 },
590 "warnings": {
591 "type": "array",
592 "items": {
593 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.WarningEvent"
594 }
595 },
596 "audit": {
597 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Audit"
598 }
599 },
600 "description": "Result of a booking info operation."
601 },
602 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Booking.Cancel.CancelResponse": {
603 "properties": {
604 "locator": {
605 "type": "string"
606 },
607 "rates": {
608 "type": "array",
609 "items": {
610 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.SelectedRate"
611 }
612 },
613 "passengers": {
614 "type": "array",
615 "items": {
616 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PassengerConfirm"
617 }
618 },
619 "status": {
620 "type": "number",
621 "format": "int32",
622 "enum": [
623 0,
624 1,
625 2,
626 3
627 ]
628 },
629 "warnings": {
630 "type": "array",
631 "items": {
632 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.WarningEvent"
633 }
634 },
635 "audit": {
636 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Audit"
637 }
638 },
639 "description": "Result of a booking cancel operation."
640 },
641 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Error": {
642 "type": "object",
643 "properties": {
644 "message": {
645 "type": "string",
646 "description": "Describes the occurred error."
647 },
648 "comments": {
649 "type": "array",
650 "description": "Depending on the type of error, some comments may be included for clarification.",
651 "items": {
652 "type": "string"
653 }
654 },
655 "audit": {
656 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Application.Messages.Audit"
657 }
658 },
659 "description": "Describes an error."
660 },
661 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.Audit": {
662 "type": "object",
663 "properties": {
664 "api_key": {
665 "type": "string",
666 "description": "ApiKey used on the request, if authentication went well."
667 },
668 "time": {
669 "type": "string",
670 "description": "Start time.",
671 "format": "date-time"
672 },
673 "duration": {
674 "type": "integer",
675 "description": "Duration of the transaction in milliseconds."
676 }
677 },
678 "description": "Includes audit information of the transaction."
679 },
680 "HolidayExperiences.Banks.Transfers.Api.Application.Messages.WarningEvent": {
681 "properties": {
682 "relates": {
683 "type": "string",
684 "description": "What the event relates to.",
685 "enum": [
686 "request",
687 "provider",
688 "product"
689 ]
690 },
691 "reference": {
692 "type": "string",
693 "description": "This reference, depending on which one the event type is; may be useful to identify the element that caused the warning."
694 },
695 "comment": {
696 "type": "string",
697 "description": "This reference, depending on which one the event type is; may be useful to identify the element that caused the warning."
698 }
699 },
700 "description": "Includes detail about an unexpected event."
701 },
702 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.CancellationPolicy": {
703 "properties": {
704 "start": {
705 "type": "string",
706 "description": "When this policy begins to apply (included).",
707 "format": "date-time"
708 },
709 "end": {
710 "type": "string",
711 "description": "When this policy finishes applying (not included).",
712 "format": "date-time"
713 },
714 "price": {
715 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price"
716 }
717 },
718 "description": "Describes the applicable cancellation expenses within two dates."
719 },
720 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.ContactPhone": {
721 "properties": {
722 "phone_number": {
723 "type": "string",
724 "description": "Phone number."
725 },
726 "terminal_type": {
727 "type": "integer",
728 "description": "Type of phone terminal.",
729 "enum": [
730 0,
731 1,
732 2,
733 3,
734 4,
735 5,
736 6,
737 7,
738 8
739 ]
740 },
741 "usage_type": {
742 "type": "integer",
743 "description": "Type of usage of this phone number.",
744 "enum": [
745 0,
746 1,
747 2,
748 3,
749 4,
750 5,
751 6,
752 7,
753 8,
754 9
755 ]
756 }
757 },
758 "description": "Includes information about the contact phones of the vendor."
759 },
760 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Customer": {
761 "properties": {
762 "name": {
763 "type": "string",
764 "description": "Name of the customer."
765 },
766 "surname": {
767 "type": "string",
768 "description": "Surname of the customer."
769 },
770 "birthdate": {
771 "type": "string",
772 "description": "Date of birth.",
773 "format": "date-time"
774 },
775 "phone": {
776 "type": "string",
777 "description": "Contact phone of the customer."
778 },
779 "email": {
780 "type": "string",
781 "description": "Contact email of the customer."
782 }
783 },
784 "description": "Information about the booking holder."
785 },
786 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.HotelInfo": {
787 "properties": {
788 "event": {
789 "type": "string",
790 "description": "Type of hotel event.",
791 "enum": [
792 "checkin",
793 "checkout"
794 ]
795 },
796 "code": {
797 "type": "integer",
798 "description": "Hotel code, according to Logitravel Group masters."
799 },
800 "name": {
801 "type": "string",
802 "description": "Hotel name."
803 },
804 "date": {
805 "type": "string",
806 "description": "Date and time of the transport event.",
807 "format": "date-time"
808 },
809 "address": {
810 "type": "string",
811 "description": "Address of the hotel."
812 }
813 },
814 "description": "Details information about an hotel event and its schedule."
815 },
816 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Location": {
817 "properties": {
818 "type": {
819 "type": "integer",
820 "description": "Type of location.",
821 "enum": [
822 0,
823 1,
824 2,
825 3,
826 4,
827 5,
828 6,
829 7
830 ]
831 },
832 "code": {
833 "type": "string",
834 "description": "Location code. All of these location codes must match the Logitravel Group masters."
835 },
836 "latitude": {
837 "type": "string",
838 "description": "Latitude of the location."
839 },
840 "longitude": {
841 "type": "string",
842 "description": "Longitude of the location."
843 },
844 "transport": {
845 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.TransportInfo"
846 },
847 "hotel": {
848 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.HotelInfo"
849 }
850 },
851 "description": "Describes a location, and relates some information about the transport or the hotel event if necessary."
852 },
853 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Parameter": {
854 "properties": {
855 "key": {
856 "type": "string",
857 "description": "The parameter name."
858 },
859 "value": {
860 "type": "string",
861 "description": "The parameter value."
862 }
863 },
864 "description": "An open parameter to be included in rates. \nThese parameters are included in the availability response. Quotation operations may require sending these parameters back.\n"
865 },
866 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Passenger": {
867 "properties": {
868 "id": {
869 "type": "integer",
870 "description": "Identifies the passenger. This ID can be created sequentially for the Availability Request."
871 },
872 "age": {
873 "type": "integer",
874 "description": "Age of the passenger. 30 as default can be used for adults, though is not recommended to use default values for children or infants."
875 }
876 },
877 "description": "Describes the basic information of a passenger."
878 },
879 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PassengerConfirm": {
880 "properties": {
881 "passenger": {
882 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Passenger"
883 },
884 "name": {
885 "type": "string",
886 "description": "Complete name of the passenger."
887 },
888 "surname": {
889 "type": "string",
890 "description": "Complete surname of the passenger."
891 }
892 },
893 "description": "Completes the passenger data for Confirmation transactions."
894 },
895 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Preferences": {
896 "type": "object",
897 "properties": {
898 "language": {
899 "type": "string",
900 "description": "Language that has to be used on the response content."
901 }
902 },
903 "description": "Specifies the search preferences."
904 },
905 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price": {
906 "properties": {
907 "currency": {
908 "type": "string",
909 "description": "The price currency. ISO-4217 code."
910 },
911 "value": {
912 "type": "number",
913 "description": "The price value."
914 },
915 "type": {
916 "type": "integer",
917 "description": "The price type.",
918 "enum": [
919 0,
920 1,
921 2
922 ]
923 }
924 },
925 "description": "Represents the price of something."
926 },
927 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PriceBreakdown": {
928 "properties": {
929 "rows": {
930 "type": "array",
931 "description": "List of priced concepts.",
932 "items": {
933 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PriceRow"
934 }
935 },
936 "price": {
937 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price"
938 }
939 },
940 "description": "Represents a complete breakdown of prices with concepts."
941 },
942 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.PriceRow": {
943 "properties": {
944 "concept": {
945 "type": "string",
946 "description": "Describes the concept which price is informed."
947 },
948 "quantity": {
949 "type": "integer",
950 "description": "The amount."
951 },
952 "price": {
953 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price"
954 }
955 },
956 "description": "A concept, a quantity and the price per unit."
957 },
958 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.QuantityPriceInfo": {
959 "properties": {
960 "from": {
961 "type": "integer",
962 "description": "Where the range begins (included)."
963 },
964 "to": {
965 "type": "integer",
966 "description": "Where the range ends (not included)."
967 },
968 "price": {
969 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price"
970 },
971 "type": {
972 "type": "integer",
973 "description": "Indicates how the price has to apply.",
974 "format": "int32",
975 "enum": [
976 0,
977 1
978 ]
979 }
980 },
981 "description": "Contains information about how much costs a range of items."
982 },
983 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Rate": {
984 "properties": {
985 "id": {
986 "type": "integer",
987 "description": "Identifies the rate."
988 },
989 "transfer": {
990 "type": "integer",
991 "description": "References the transfer which this rate applies to."
992 },
993 "option": {
994 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.RateOption"
995 },
996 "price": {
997 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price"
998 },
999 "baggage_price": {
1000 "type": "array",
1001 "description": "Information about the baggage prices.",
1002 "items": {
1003 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.QuantityPriceInfo"
1004 }
1005 },
1006 "cancellation_policies": {
1007 "type": "array",
1008 "description": "Information about the cancellation policies of this rate.",
1009 "items": {
1010 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.CancellationPolicy"
1011 }
1012 }
1013 },
1014 "description": "Describes an available rate and its options."
1015 },
1016 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.RateOption": {
1017 "properties": {
1018 "segment": {
1019 "type": "integer",
1020 "description": "References the segment, as provided in the request; that this option refers to."
1021 },
1022 "parameters": {
1023 "type": "array",
1024 "description": "Options can include or not a list of open parameters. These values may be required when quoting the option.",
1025 "items": {
1026 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Parameter"
1027 }
1028 }
1029 },
1030 "description": "Describes a concrete option for a rate."
1031 },
1032 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Segment": {
1033 "properties": {
1034 "id": {
1035 "type": "integer",
1036 "description": "Identifies the segment. This ID can be created sequentially for the Availability Request."
1037 },
1038 "start": {
1039 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Location"
1040 },
1041 "end": {
1042 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Location"
1043 }
1044 },
1045 "description": "Describes the basic information of a transfer segment."
1046 },
1047 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.SelectedRate": {
1048 "properties": {
1049 "transfer": {
1050 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Transfer"
1051 },
1052 "rate": {
1053 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Rate"
1054 },
1055 "price": {
1056 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Price"
1057 },
1058 "vendor": {
1059 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Vendor"
1060 }
1061 }
1062 },
1063 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Transfer": {
1064 "properties": {
1065 "id": {
1066 "type": "integer",
1067 "description": "Identifies the transfer service."
1068 },
1069 "info": {
1070 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.TransferInfo"
1071 },
1072 "start": {
1073 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Location"
1074 },
1075 "end": {
1076 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Location"
1077 },
1078 "duration": {
1079 "type": "integer",
1080 "description": "Duration in minutes of the transfer service."
1081 }
1082 },
1083 "description": "Describes a transfer service, schedule and related events."
1084 },
1085 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.TransferInfo": {
1086 "properties": {
1087 "service_type": {
1088 "type": "integer",
1089 "description": "Type of transfer service.",
1090 "enum": [
1091 0,
1092 1,
1093 2
1094 ]
1095 },
1096 "service_category": {
1097 "type": "integer",
1098 "description": "Category of the transfer service.",
1099 "enum": [
1100 0,
1101 1,
1102 2,
1103 3,
1104 4,
1105 5,
1106 6,
1107 7
1108 ]
1109 },
1110 "vehicle_type": {
1111 "type": "integer",
1112 "description": "Type of vehicle.",
1113 "enum": [
1114 0,
1115 1,
1116 2,
1117 3,
1118 4,
1119 5,
1120 6,
1121 7,
1122 8,
1123 9,
1124 10,
1125 11,
1126 12,
1127 13,
1128 14
1129 ]
1130 },
1131 "vehicle_category": {
1132 "type": "integer",
1133 "description": "Category of the vehicle.",
1134 "enum": [
1135 0,
1136 1,
1137 2,
1138 3,
1139 4,
1140 5,
1141 6,
1142 7
1143 ]
1144 },
1145 "language": {
1146 "type": "string",
1147 "description": "Language spoken by the transfer host."
1148 },
1149 "vendor_messages": {
1150 "type": "array",
1151 "description": "Notes from the vendor.",
1152 "items": {
1153 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.VendorMessage"
1154 }
1155 },
1156 "time_in_advance": {
1157 "type": "integer",
1158 "description": "Time in advance (minutes) to show up required by the vendor."
1159 }
1160 },
1161 "description": "Information about a transfer service."
1162 },
1163 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.TransportInfo": {
1164 "properties": {
1165 "event": {
1166 "type": "string",
1167 "description": "Type of transport event.",
1168 "enum": [
1169 "departure",
1170 "arrival"
1171 ]
1172 },
1173 "date": {
1174 "type": "string",
1175 "description": "Date and time of the transport event.",
1176 "format": "date-time"
1177 },
1178 "terminal": {
1179 "type": "string",
1180 "description": "Terminal code."
1181 },
1182 "transport_number": {
1183 "type": "string",
1184 "description": "Transport number."
1185 }
1186 },
1187 "description": "Details information about a transport event and its schedule."
1188 },
1189 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.UrlResource": {
1190 "properties": {
1191 "url": {
1192 "type": "string",
1193 "description": "URL where the resource is located."
1194 }
1195 },
1196 "description": "Describes a resource that can be downloaded from a URL."
1197 },
1198 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.Vendor": {
1199 "properties": {
1200 "name": {
1201 "type": "string",
1202 "description": "Commercial name of the vendor."
1203 },
1204 "contact_phones": {
1205 "type": "array",
1206 "description": "Contact phones where vendor can be contacted.",
1207 "items": {
1208 "$ref": "#/components/schemas/HolidayExperiences.Banks.Transfers.Api.Domain.Entities.ContactPhone"
1209 }
1210 }
1211 },
1212 "description": "Contains information about a vendor and its contact phones."
1213 },
1214 "HolidayExperiences.Banks.Transfers.Api.Domain.Entities.VendorMessage": {
1215 "properties": {
1216 "type": {
1217 "type": "integer",
1218 "description": "Type of vendor message.",
1219 "enum": [
1220 0,
1221 1,
1222 2,
1223 3,
1224 4,
1225 5,
1226 6,
1227 7
1228 ]
1229 },
1230 "language": {
1231 "type": "string",
1232 "description": "Language of the message."
1233 },
1234 "title": {
1235 "type": "string",
1236 "description": "Title of the message."
1237 },
1238 "text": {
1239 "type": "string",
1240 "description": "Content of the message."
1241 }
1242 },
1243 "description": "Represents a message about the transfer service provided by a vendor."
1244 }
1245 }
1246 }
1247}