POST GetClusterExcelData?FromDate={FromDate}&ToDate={ToDate}&LOS={LOS}&Guest={Guest}&ShopDateTime={ShopDateTime}

Request Information

URI Parameters

Name	Type	Additional information
FromDate	string	Required
ToDate	string	Required
LOS	string	Required
Guest	string	Required
ShopDateTime	string	Default value is

Body Parameters

PriceOptimizationRequestEntity

Name	Type	Additional information
LOS	string	None.
Guest	string	None.
ProductTypeID	string	None.
ProductTypeIDText	string	None.
InclusionID	Collection of string	None.
InclusionIDText	Collection of string	None.
Properties	Collection of integer	None.
Channels	Collection of integer	None.
PropertiesText	Collection of string	None.
ChannelsText	Collection of string	None.
Promotion	boolean	None.
Qualification	boolean	None.
Restriction	boolean	None.
RestrictionText	string	None.
PromotionText	string	None.
QualificationText	string	None.
CheckInStartDate	date	None.
CustomerDatetime	date	None.
CheckInEndDate	date	None.
SID	integer	None.
SubscriberPropertyID	integer	None.
SubscriberName	string	None.
MSIRequired	boolean	None.
BenchmarkRequired	boolean	None.
CompsetRatesRequired	boolean	None.
ShopDateTime	date	None.
IsILOSApplicable	boolean	None.
SIDData	Collection of SIDData	None.
ExcelSIDs	Collection of integer	None.
IsTrendCall	boolean	None.
IsSecondary	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "LOS": "sample string 1",
  "Guest": "sample string 2",
  "ProductTypeID": "sample string 3",
  "ProductTypeIDText": "sample string 4",
  "InclusionID": [
    "sample string 1",
    "sample string 2"
  ],
  "InclusionIDText": [
    "sample string 1",
    "sample string 2"
  ],
  "Properties": [
    1,
    2
  ],
  "Channels": [
    1,
    2
  ],
  "PropertiesText": [
    "sample string 1",
    "sample string 2"
  ],
  "ChannelsText": [
    "sample string 1",
    "sample string 2"
  ],
  "Promotion": true,
  "Qualification": true,
  "Restriction": true,
  "RestrictionText": "sample string 5",
  "PromotionText": "sample string 6",
  "QualificationText": "sample string 7",
  "CheckInStartDate": "2025-04-28T16:36:40.4294061+00:00",
  "CustomerDatetime": "2025-04-28T16:36:40.4294061+00:00",
  "CheckInEndDate": "2025-04-28T16:36:40.4294061+00:00",
  "SID": 11,
  "SubscriberPropertyID": 12,
  "SubscriberName": "sample string 13",
  "MSIRequired": true,
  "BenchmarkRequired": true,
  "CompsetRatesRequired": true,
  "ShopDateTime": "2025-04-28T16:36:40.4294061+00:00",
  "IsILOSApplicable": true,
  "SIDData": [
    {
      "SID": 1,
      "SubsPropID": 2
    },
    {
      "SID": 1,
      "SubsPropID": 2
    }
  ],
  "ExcelSIDs": [
    1,
    2
  ],
  "IsTrendCall": true,
  "IsSecondary": true
}

text/html

Sample:

{"LOS":"sample string 1","Guest":"sample string 2","ProductTypeID":"sample string 3","ProductTypeIDText":"sample string 4","InclusionID":["sample string 1","sample string 2"],"InclusionIDText":["sample string 1","sample string 2"],"Properties":[1,2],"Channels":[1,2],"PropertiesText":["sample string 1","sample string 2"],"ChannelsText":["sample string 1","sample string 2"],"Promotion":true,"Qualification":true,"Restriction":true,"RestrictionText":"sample string 5","PromotionText":"sample string 6","QualificationText":"sample string 7","CheckInStartDate":"2025-04-28T16:36:40.4294061+00:00","CustomerDatetime":"2025-04-28T16:36:40.4294061+00:00","CheckInEndDate":"2025-04-28T16:36:40.4294061+00:00","SID":11,"SubscriberPropertyID":12,"SubscriberName":"sample string 13","MSIRequired":true,"BenchmarkRequired":true,"CompsetRatesRequired":true,"ShopDateTime":"2025-04-28T16:36:40.4294061+00:00","IsILOSApplicable":true,"SIDData":[{"SID":1,"SubsPropID":2},{"SID":1,"SubsPropID":2}],"ExcelSIDs":[1,2],"IsTrendCall":true,"IsSecondary":true}

application/xml, text/xml

Sample:

<PriceOptimizationRequestEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <BenchmarkRequired>true</BenchmarkRequired>
  <Channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Channels>
  <ChannelsText xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ChannelsText>
  <CheckInEndDate>2025-04-28T16:36:40.4294061+00:00</CheckInEndDate>
  <CheckInStartDate>2025-04-28T16:36:40.4294061+00:00</CheckInStartDate>
  <CompsetRatesRequired>true</CompsetRatesRequired>
  <CustomerDatetime>2025-04-28T16:36:40.4294061+00:00</CustomerDatetime>
  <ExcelSIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ExcelSIDs>
  <Guest>sample string 2</Guest>
  <InclusionID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </InclusionID>
  <InclusionIDText xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </InclusionIDText>
  <IsILOSApplicable>true</IsILOSApplicable>
  <IsSecondary>true</IsSecondary>
  <IsTrendCall>true</IsTrendCall>
  <LOS>sample string 1</LOS>
  <MSIRequired>true</MSIRequired>
  <ProductTypeID>sample string 3</ProductTypeID>
  <ProductTypeIDText>sample string 4</ProductTypeIDText>
  <Promotion>true</Promotion>
  <PromotionText>sample string 6</PromotionText>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Properties>
  <PropertiesText xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PropertiesText>
  <Qualification>true</Qualification>
  <QualificationText>sample string 7</QualificationText>
  <Restriction>true</Restriction>
  <RestrictionText>sample string 5</RestrictionText>
  <SID>11</SID>
  <SIDData>
    <SIDData>
      <SID>1</SID>
      <SubsPropID>2</SubsPropID>
    </SIDData>
    <SIDData>
      <SID>1</SID>
      <SubsPropID>2</SubsPropID>
    </SIDData>
  </SIDData>
  <ShopDateTime>2025-04-28T16:36:40.4294061+00:00</ShopDateTime>
  <SubscriberName>sample string 13</SubscriberName>
  <SubscriberPropertyID>12</SubscriberPropertyID>
</PriceOptimizationRequestEntity>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PriceOptimizationRequestEntity'.

Response Information

Resource Description

ResponseOfListOfClusterExcelData

Name	Type	Additional information
Message	string	None.
Status	boolean	None.
Body	Collection of ClusterExcelData	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "SID": 1,
      "SubscriberName": "sample string 2",
      "PropertyID": 3,
      "PropertyName": "sample string 4",
      "ChannelID": 5,
      "ChannelName": "sample string 6",
      "CheckInDate": "2025-04-28T16:36:40.4294061+00:00",
      "Rate": "sample string 8",
      "Currency": "sample string 9",
      "Description": "sample string 10",
      "RateCategory": "sample string 11",
      "Inclusion": "sample string 12",
      "Restriction": true,
      "ProductName": "sample string 14",
      "LOS": 15,
      "Guest": 16,
      "PropOrder": 17,
      "ShoppedDateTime": "2025-04-28T16:36:40.4294061+00:00",
      "City": "sample string 19",
      "Country": "sample string 20"
    },
    {
      "SID": 1,
      "SubscriberName": "sample string 2",
      "PropertyID": 3,
      "PropertyName": "sample string 4",
      "ChannelID": 5,
      "ChannelName": "sample string 6",
      "CheckInDate": "2025-04-28T16:36:40.4294061+00:00",
      "Rate": "sample string 8",
      "Currency": "sample string 9",
      "Description": "sample string 10",
      "RateCategory": "sample string 11",
      "Inclusion": "sample string 12",
      "Restriction": true,
      "ProductName": "sample string 14",
      "LOS": 15,
      "Guest": 16,
      "PropOrder": 17,
      "ShoppedDateTime": "2025-04-28T16:36:40.4294061+00:00",
      "City": "sample string 19",
      "Country": "sample string 20"
    }
  ]
}

text/html

Sample:

{"Message":"sample string 1","Status":true,"Body":[{"SID":1,"SubscriberName":"sample string 2","PropertyID":3,"PropertyName":"sample string 4","ChannelID":5,"ChannelName":"sample string 6","CheckInDate":"2025-04-28T16:36:40.4294061+00:00","Rate":"sample string 8","Currency":"sample string 9","Description":"sample string 10","RateCategory":"sample string 11","Inclusion":"sample string 12","Restriction":true,"ProductName":"sample string 14","LOS":15,"Guest":16,"PropOrder":17,"ShoppedDateTime":"2025-04-28T16:36:40.4294061+00:00","City":"sample string 19","Country":"sample string 20"},{"SID":1,"SubscriberName":"sample string 2","PropertyID":3,"PropertyName":"sample string 4","ChannelID":5,"ChannelName":"sample string 6","CheckInDate":"2025-04-28T16:36:40.4294061+00:00","Rate":"sample string 8","Currency":"sample string 9","Description":"sample string 10","RateCategory":"sample string 11","Inclusion":"sample string 12","Restriction":true,"ProductName":"sample string 14","LOS":15,"Guest":16,"PropOrder":17,"ShoppedDateTime":"2025-04-28T16:36:40.4294061+00:00","City":"sample string 19","Country":"sample string 20"}]}

application/xml, text/xml

Sample:

<ResponseOfArrayOfClusterExcelDataQzIzD0mn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body>
    <ClusterExcelData>
      <ChannelID>5</ChannelID>
      <ChannelName>sample string 6</ChannelName>
      <CheckInDate>2025-04-28T16:36:40.4294061+00:00</CheckInDate>
      <City>sample string 19</City>
      <Country>sample string 20</Country>
      <Currency>sample string 9</Currency>
      <Description>sample string 10</Description>
      <Guest>16</Guest>
      <Inclusion>sample string 12</Inclusion>
      <LOS>15</LOS>
      <ProductName>sample string 14</ProductName>
      <PropOrder>17</PropOrder>
      <PropertyID>3</PropertyID>
      <PropertyName>sample string 4</PropertyName>
      <Rate>sample string 8</Rate>
      <RateCategory>sample string 11</RateCategory>
      <Restriction>true</Restriction>
      <SID>1</SID>
      <ShoppedDateTime>2025-04-28T16:36:40.4294061+00:00</ShoppedDateTime>
      <SubscriberName>sample string 2</SubscriberName>
    </ClusterExcelData>
    <ClusterExcelData>
      <ChannelID>5</ChannelID>
      <ChannelName>sample string 6</ChannelName>
      <CheckInDate>2025-04-28T16:36:40.4294061+00:00</CheckInDate>
      <City>sample string 19</City>
      <Country>sample string 20</Country>
      <Currency>sample string 9</Currency>
      <Description>sample string 10</Description>
      <Guest>16</Guest>
      <Inclusion>sample string 12</Inclusion>
      <LOS>15</LOS>
      <ProductName>sample string 14</ProductName>
      <PropOrder>17</PropOrder>
      <PropertyID>3</PropertyID>
      <PropertyName>sample string 4</PropertyName>
      <Rate>sample string 8</Rate>
      <RateCategory>sample string 11</RateCategory>
      <Restriction>true</Restriction>
      <SID>1</SID>
      <ShoppedDateTime>2025-04-28T16:36:40.4294061+00:00</ShoppedDateTime>
      <SubscriberName>sample string 2</SubscriberName>
    </ClusterExcelData>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfClusterExcelDataQzIzD0mn>