Skip to content

Commit 194f95c

Browse files
rb80rb80
authored
Merge pull request #48 from oracle/feature/updated-async-specs
Updated Async API specifications
2 parents 6daf38b + cd8c9ee commit 194f95c

File tree

3 files changed

+425
-188
lines changed

3 files changed

+425
-188
lines changed

‎rest-api-specs/property/blkasync.json‎

Lines changed: 174 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"swagger": "2.0",
33
"info": {
44
"title": "OPERA Cloud Block Reservation Asynchronous API",
5-
"description": "APIs to cater Block Reservation related asynchronous functionality in OPERA.<br /><br />Compatible with OPERA Cloud release 21.5.0.0.<br /><br /><p>This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020,2022 Oracle and/or its affiliates.</p>",
6-
"version": "21.5.0.0",
5+
"description": "APIs to cater Block Reservation related asynchronous functionality in OPERA.<br /><br /> Compatible with OPERA Cloud release 22.4.0.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2022 Oracle and/or its affiliates.</p>",
6+
"version": "22.4.0.0",
77
"termsOfService": "https://www.oracle.com/legal/terms.html",
88
"contact": {
99
"email": "hospitality_apis_ww_grp@oracle.com"
@@ -122,8 +122,8 @@
122122
},
123123
"/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary/{requestId}": {
124124
"head": {
125-
"summary": "This API returns the status of asynchronous process scheduled for given id.",
126-
"description": " <p><strong>OperationId:</strong>getBlockAllocationSummaryProcessStatus</p>",
125+
"summary": "Check status of Block Allocation Summary process",
126+
"description": "Use this to check whether the summary of block allocation is ready yet. You can get value of summaryId from the header parameter Location, returned by the startBlockAllocationSummaryProcess operation. Once the process is completed, HEAD response returns status = COMPLETED and a header parameter Location with a summary ID for getBlockAllocationSummary API. <p><strong>OperationId:</strong>getBlockAllocationSummaryProcessStatus</p>",
127127
"operationId": "getBlockAllocationSummaryProcessStatus",
128128
"responses": {
129129
"200": {
@@ -571,12 +571,6 @@
571571
"minLength": 0,
572572
"maxLength": 80
573573
},
574-
"masterBlockId": {
575-
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
576-
"type": "string",
577-
"minLength": 0,
578-
"maxLength": 80
579-
},
580574
"blockCode": {
581575
"description": "Defined block code for the block.",
582576
"type": "string",
@@ -589,6 +583,12 @@
589583
"minLength": 0,
590584
"maxLength": 2000
591585
},
586+
"masterBlockId": {
587+
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
588+
"type": "string",
589+
"minLength": 0,
590+
"maxLength": 80
591+
},
592592
"status": {
593593
"description": "Booking Status of the block.",
594594
"type": "string",
@@ -603,23 +603,23 @@
603603
},
604604
"startDate": {
605605
"type": "string",
606-
"format": "date"
606+
"format": "date-time"
607607
},
608608
"endDate": {
609609
"type": "string",
610-
"format": "date"
610+
"format": "date-time"
611611
},
612612
"cutOffDate": {
613613
"type": "string",
614-
"format": "date"
614+
"format": "date-time"
615615
},
616616
"cutOffDays": {
617617
"type": "integer"
618618
},
619619
"cancellationDate": {
620620
"description": "Cancellation Date.",
621621
"type": "string",
622-
"format": "date"
622+
"format": "date-time"
623623
},
624624
"cancellationCode": {
625625
"description": "Code that idenfies the reason for cancellation.",
@@ -681,19 +681,6 @@
681681
"minLength": 0,
682682
"maxLength": 20
683683
},
684-
"allocationDates": {
685-
"type": "array",
686-
"maxItems": 4000,
687-
"items": {
688-
"$ref": "#/definitions/roomAllocationDateType"
689-
}
690-
},
691-
"hotelId": {
692-
"description": "The Hotel Code the block belongs to.",
693-
"type": "string",
694-
"minLength": 0,
695-
"maxLength": 20
696-
},
697684
"createDateTime": {
698685
"description": "The business date the block was created.",
699686
"type": "string",
@@ -710,54 +697,86 @@
710697
"type": "string",
711698
"minLength": 0,
712699
"maxLength": 20
700+
},
701+
"ratePlanCode": {
702+
"description": "Rate code associated with Block.",
703+
"type": "string",
704+
"minLength": 0,
705+
"maxLength": 20
706+
},
707+
"lastModifiedDate": {
708+
"description": "Date Time when the block was modified last.",
709+
"type": "string",
710+
"format": "date-time"
711+
},
712+
"sourceCode": {
713+
"description": "Source of the Block.",
714+
"type": "string",
715+
"minLength": 0,
716+
"maxLength": 20
717+
},
718+
"allocationDates": {
719+
"type": "array",
720+
"maxItems": 4000,
721+
"items": {
722+
"$ref": "#/definitions/roomAllocationDateType"
723+
}
713724
}
714725
}
715726
},
716727
"roomAllocationDateType": {
717728
"type": "object",
718729
"properties": {
730+
"allocationDate": {
731+
"description": "The block date for which the allocation details are listed.",
732+
"type": "string",
733+
"format": "date-time"
734+
},
719735
"allocations": {
720736
"type": "array",
721737
"maxItems": 4000,
722738
"items": {
723739
"$ref": "#/definitions/roomAllocationDetailsType"
724740
}
725-
},
726-
"allocationDate": {
727-
"description": "The block date for which the allocation details are listed.",
728-
"type": "string",
729-
"format": "date"
730741
}
731742
}
732743
},
733744
"roomAllocationDetailsType": {
734745
"type": "object",
735746
"properties": {
736-
"inventory": {
737-
"description": "The break up of projected rooms by occupancy.",
738-
"$ref": "#/definitions/blockGridInvType"
739-
},
740-
"rates": {
741-
"description": "The break up of occupancy rates.",
742-
"$ref": "#/definitions/blockGridRatesType"
747+
"originalRooms": {
748+
"description": "The total original( forecasted ) rooms for the block.",
749+
"type": "integer"
743750
},
744751
"roomType": {
745752
"description": "The room type for which the allocation details are listed.",
746753
"type": "string",
747754
"minLength": 0,
748755
"maxLength": 20
749756
},
750-
"originalRooms": {
751-
"description": "The total original( forecasted ) rooms for the block.",
752-
"type": "integer"
753-
},
754757
"currentRooms": {
755758
"description": "The total current( projected + pickup ) rooms for the block.",
756759
"type": "integer"
757760
},
758761
"pickupRooms": {
759762
"description": "The total pickup rooms for the block.",
760763
"type": "integer"
764+
},
765+
"inventory": {
766+
"description": "The break up of projected rooms by occupancy.",
767+
"$ref": "#/definitions/blockGridInvType"
768+
},
769+
"rates": {
770+
"description": "The break up of occupancy rates.",
771+
"$ref": "#/definitions/blockGridRatesType"
772+
},
773+
"actualRevenue": {
774+
"description": "The break up of actual revenue for room type. Applicable for past dates, business date or future dates.",
775+
"$ref": "#/definitions/blockActualRevenueType"
776+
},
777+
"potentialRevenue": {
778+
"description": "The break up of potential revenue for room type. Applicable for business date or future dates.",
779+
"$ref": "#/definitions/blockPotenitalRevenueType"
761780
}
762781
}
763782
},
@@ -787,6 +806,106 @@
787806
}
788807
}
789808
},
809+
"blockActualRevenueType": {
810+
"type": "object",
811+
"description": "Indicates the sum of revenue breakup per room type per block per allocation date for the reservations. Applicable for past dates, business date or future dates.",
812+
"properties": {
813+
"roomRevenue": {
814+
"description": "Indicates room revenue amount.",
815+
"type": "number"
816+
},
817+
"foodRevenue": {
818+
"description": "Indicates food revenue amount.",
819+
"type": "number"
820+
},
821+
"otherRevenue": {
822+
"description": "Indicates other revenue amount.",
823+
"type": "number"
824+
},
825+
"nonRevenue": {
826+
"description": "Indicates non revenue amount.",
827+
"type": "number"
828+
},
829+
"totalRevenue": {
830+
"description": "Indicates total revenue amount.",
831+
"type": "number"
832+
},
833+
"roomRevenueTax": {
834+
"description": "Indicates room revenue tax amount.",
835+
"type": "number"
836+
},
837+
"foodRevenueTax": {
838+
"description": "Indicates food revenue tax amount.",
839+
"type": "number"
840+
},
841+
"otherRevenueTax": {
842+
"description": "Indicates other revenue tax amount.",
843+
"type": "number"
844+
},
845+
"nonRevenueTax": {
846+
"description": "Indicates non revenue tax amount.",
847+
"type": "number"
848+
},
849+
"totalRevenueTax": {
850+
"description": "Indicates total revenue tax amount.",
851+
"type": "number"
852+
},
853+
"currency": {
854+
"description": "Currency code to reflect the currency in which an amount may be expressed.",
855+
"type": "string"
856+
}
857+
}
858+
},
859+
"blockPotenitalRevenueType": {
860+
"type": "object",
861+
"description": "Indicates the sum of revenue breakup per room type per block per allocation date for the reservations. Applicable for business date or future dates.",
862+
"properties": {
863+
"roomRevenue": {
864+
"description": "Indicates room revenue amount.",
865+
"type": "number"
866+
},
867+
"foodRevenue": {
868+
"description": "Indicates food revenue amount.",
869+
"type": "number"
870+
},
871+
"otherRevenue": {
872+
"description": "Indicates other revenue amount.",
873+
"type": "number"
874+
},
875+
"nonRevenue": {
876+
"description": "Indicates non revenue amount.",
877+
"type": "number"
878+
},
879+
"totalRevenue": {
880+
"description": "Indicates total revenue amount.",
881+
"type": "number"
882+
},
883+
"roomRevenueTax": {
884+
"description": "Indicates room revenue tax amount.",
885+
"type": "number"
886+
},
887+
"foodRevenueTax": {
888+
"description": "Indicates food revenue tax amount.",
889+
"type": "number"
890+
},
891+
"otherRevenueTax": {
892+
"description": "Indicates other revenue tax amount.",
893+
"type": "number"
894+
},
895+
"nonRevenueTax": {
896+
"description": "Indicates non revenue tax amount.",
897+
"type": "number"
898+
},
899+
"totalRevenueTax": {
900+
"description": "Indicates total revenue tax amount.",
901+
"type": "number"
902+
},
903+
"currency": {
904+
"description": "Currency code to reflect the currency in which an amount may be expressed.",
905+
"type": "string"
906+
}
907+
}
908+
},
790909
"blockGridRatesType": {
791910
"type": "object",
792911
"description": "Indicates the rate amount values per person occupancy.",
@@ -824,6 +943,18 @@
824943
"endDate": {
825944
"type": "string",
826945
"format": "date"
946+
},
947+
"occupancyDate": {
948+
"type": "string",
949+
"format": "date"
950+
},
951+
"startLastModifiedDate": {
952+
"type": "string",
953+
"format": "date-time"
954+
},
955+
"endLastModifiedDate": {
956+
"type": "string",
957+
"format": "date-time"
827958
}
828959
}
829960
},

0 commit comments

Comments
 (0)