POST GetSupply

Request Information

URI Parameters

None.

Body Parameters

SupplyRequest
NameDescriptionTypeAdditional information
LOS

string

None.

Guest

string

None.

CheckInStartDate

date

None.

CheckInEndDate

date

None.

SID

integer

None.

PropertyID

integer

None.

PropertyName

string

None.

ShopDateTime

date

None.

Request Formats

application/json, text/json

Sample:
{
  "LOS": "sample string 1",
  "Guest": "sample string 2",
  "CheckInStartDate": "2025-04-28T17:29:54.4520639+00:00",
  "CheckInEndDate": "2025-04-28T17:29:54.4520639+00:00",
  "SID": 5,
  "PropertyID": 6,
  "PropertyName": "sample string 7",
  "ShopDateTime": "2025-04-28T17:29:54.4520639+00:00"
}

text/html

Sample:
{"LOS":"sample string 1","Guest":"sample string 2","CheckInStartDate":"2025-04-28T17:29:54.4520639+00:00","CheckInEndDate":"2025-04-28T17:29:54.4520639+00:00","SID":5,"PropertyID":6,"PropertyName":"sample string 7","ShopDateTime":"2025-04-28T17:29:54.4520639+00:00"}

application/xml, text/xml

Sample:
<SupplyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Supply">
  <CheckInEndDate>2025-04-28T17:29:54.4520639+00:00</CheckInEndDate>
  <CheckInStartDate>2025-04-28T17:29:54.4520639+00:00</CheckInStartDate>
  <Guest>sample string 2</Guest>
  <LOS>sample string 1</LOS>
  <PropertyID>6</PropertyID>
  <PropertyName>sample string 7</PropertyName>
  <SID>5</SID>
  <ShopDateTime>2025-04-28T17:29:54.4520639+00:00</ShopDateTime>
</SupplyRequest>

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 'SupplyRequest'.

Response Information

Resource Description

ResponseOfSupplyViewModel
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

SupplyViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": {
    "LOS": 1,
    "Guest": 2,
    "SupplyEntites": [
      {
        "ComponentType": 0,
        "ComponentName": "sample string 1",
        "SupplyEntityCollection": [
          {
            "SupplyData": 1.0,
            "SupplyText": "sample string 1",
            "CheckInDate": "2025-04-28T17:29:54.4520639+00:00",
            "ColorCode": 0,
            "LOS": "sample string 3",
            "Guests": "sample string 4",
            "ShortRateDescription": "sample string 5",
            "ChannelName": "sample string 6",
            "NoofProperties": 7,
            "ShopDateTime": "2025-04-28T17:29:54.4520639+00:00"
          },
          {
            "SupplyData": 1.0,
            "SupplyText": "sample string 1",
            "CheckInDate": "2025-04-28T17:29:54.4520639+00:00",
            "ColorCode": 0,
            "LOS": "sample string 3",
            "Guests": "sample string 4",
            "ShortRateDescription": "sample string 5",
            "ChannelName": "sample string 6",
            "NoofProperties": 7,
            "ShopDateTime": "2025-04-28T17:29:54.4520639+00:00"
          }
        ]
      },
      {
        "ComponentType": 0,
        "ComponentName": "sample string 1",
        "SupplyEntityCollection": [
          {
            "SupplyData": 1.0,
            "SupplyText": "sample string 1",
            "CheckInDate": "2025-04-28T17:29:54.4520639+00:00",
            "ColorCode": 0,
            "LOS": "sample string 3",
            "Guests": "sample string 4",
            "ShortRateDescription": "sample string 5",
            "ChannelName": "sample string 6",
            "NoofProperties": 7,
            "ShopDateTime": "2025-04-28T17:29:54.4520639+00:00"
          },
          {
            "SupplyData": 1.0,
            "SupplyText": "sample string 1",
            "CheckInDate": "2025-04-28T17:29:54.4520639+00:00",
            "ColorCode": 0,
            "LOS": "sample string 3",
            "Guests": "sample string 4",
            "ShortRateDescription": "sample string 5",
            "ChannelName": "sample string 6",
            "NoofProperties": 7,
            "ShopDateTime": "2025-04-28T17:29:54.4520639+00:00"
          }
        ]
      }
    ],
    "EventEntity": [
      {
        "EventDate": "2025-04-28T17:29:54.4520639+00:00",
        "EventDetails": [
          {
            "EventName": "sample string 1",
            "EventId": 2,
            "Color": "sample string 3",
            "EventImpact": 4
          },
          {
            "EventName": "sample string 1",
            "EventId": 2,
            "Color": "sample string 3",
            "EventImpact": 4
          }
        ]
      },
      {
        "EventDate": "2025-04-28T17:29:54.4520639+00:00",
        "EventDetails": [
          {
            "EventName": "sample string 1",
            "EventId": 2,
            "Color": "sample string 3",
            "EventImpact": 4
          },
          {
            "EventName": "sample string 1",
            "EventId": 2,
            "Color": "sample string 3",
            "EventImpact": 4
          }
        ]
      }
    ]
  }
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":{"LOS":1,"Guest":2,"SupplyEntites":[{"ComponentType":0,"ComponentName":"sample string 1","SupplyEntityCollection":[{"SupplyData":1.0,"SupplyText":"sample string 1","CheckInDate":"2025-04-28T17:29:54.4520639+00:00","ColorCode":0,"LOS":"sample string 3","Guests":"sample string 4","ShortRateDescription":"sample string 5","ChannelName":"sample string 6","NoofProperties":7,"ShopDateTime":"2025-04-28T17:29:54.4520639+00:00"},{"SupplyData":1.0,"SupplyText":"sample string 1","CheckInDate":"2025-04-28T17:29:54.4520639+00:00","ColorCode":0,"LOS":"sample string 3","Guests":"sample string 4","ShortRateDescription":"sample string 5","ChannelName":"sample string 6","NoofProperties":7,"ShopDateTime":"2025-04-28T17:29:54.4520639+00:00"}]},{"ComponentType":0,"ComponentName":"sample string 1","SupplyEntityCollection":[{"SupplyData":1.0,"SupplyText":"sample string 1","CheckInDate":"2025-04-28T17:29:54.4520639+00:00","ColorCode":0,"LOS":"sample string 3","Guests":"sample string 4","ShortRateDescription":"sample string 5","ChannelName":"sample string 6","NoofProperties":7,"ShopDateTime":"2025-04-28T17:29:54.4520639+00:00"},{"SupplyData":1.0,"SupplyText":"sample string 1","CheckInDate":"2025-04-28T17:29:54.4520639+00:00","ColorCode":0,"LOS":"sample string 3","Guests":"sample string 4","ShortRateDescription":"sample string 5","ChannelName":"sample string 6","NoofProperties":7,"ShopDateTime":"2025-04-28T17:29:54.4520639+00:00"}]}],"EventEntity":[{"EventDate":"2025-04-28T17:29:54.4520639+00:00","EventDetails":[{"EventName":"sample string 1","EventId":2,"Color":"sample string 3","EventImpact":4},{"EventName":"sample string 1","EventId":2,"Color":"sample string 3","EventImpact":4}]},{"EventDate":"2025-04-28T17:29:54.4520639+00:00","EventDetails":[{"EventName":"sample string 1","EventId":2,"Color":"sample string 3","EventImpact":4},{"EventName":"sample string 1","EventId":2,"Color":"sample string 3","EventImpact":4}]}]}}

application/xml, text/xml

Sample:
<ResponseOfSupplyViewModelQzIzD0mn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body>
    <EventEntity xmlns:d3p1="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Events">
      <d3p1:EventEntites>
        <d3p1:EventDate>2025-04-28T17:29:54.4520639+00:00</d3p1:EventDate>
        <d3p1:EventDetails>
          <d3p1:PricePostioningEventView>
            <d3p1:Color>sample string 3</d3p1:Color>
            <d3p1:EventId>2</d3p1:EventId>
            <d3p1:EventImpact>4</d3p1:EventImpact>
            <d3p1:EventName>sample string 1</d3p1:EventName>
          </d3p1:PricePostioningEventView>
          <d3p1:PricePostioningEventView>
            <d3p1:Color>sample string 3</d3p1:Color>
            <d3p1:EventId>2</d3p1:EventId>
            <d3p1:EventImpact>4</d3p1:EventImpact>
            <d3p1:EventName>sample string 1</d3p1:EventName>
          </d3p1:PricePostioningEventView>
        </d3p1:EventDetails>
      </d3p1:EventEntites>
      <d3p1:EventEntites>
        <d3p1:EventDate>2025-04-28T17:29:54.4520639+00:00</d3p1:EventDate>
        <d3p1:EventDetails>
          <d3p1:PricePostioningEventView>
            <d3p1:Color>sample string 3</d3p1:Color>
            <d3p1:EventId>2</d3p1:EventId>
            <d3p1:EventImpact>4</d3p1:EventImpact>
            <d3p1:EventName>sample string 1</d3p1:EventName>
          </d3p1:PricePostioningEventView>
          <d3p1:PricePostioningEventView>
            <d3p1:Color>sample string 3</d3p1:Color>
            <d3p1:EventId>2</d3p1:EventId>
            <d3p1:EventImpact>4</d3p1:EventImpact>
            <d3p1:EventName>sample string 1</d3p1:EventName>
          </d3p1:PricePostioningEventView>
        </d3p1:EventDetails>
      </d3p1:EventEntites>
    </EventEntity>
    <Guest>2</Guest>
    <LOS>1</LOS>
    <SupplyEntites>
      <SupplyContainerEntity>
        <ComponentName>sample string 1</ComponentName>
        <ComponentType>MySubscriberRate</ComponentType>
        <SupplyEntityCollection>
          <SupplyEntityModel>
            <ChannelName>sample string 6</ChannelName>
            <CheckInDate>2025-04-28T17:29:54.4520639+00:00</CheckInDate>
            <ColorCode>None</ColorCode>
            <Guests>sample string 4</Guests>
            <LOS>sample string 3</LOS>
            <NoofProperties>7</NoofProperties>
            <ShopDateTime>2025-04-28T17:29:54.4520639+00:00</ShopDateTime>
            <ShortRateDescription>sample string 5</ShortRateDescription>
            <SupplyData>1</SupplyData>
            <SupplyText>sample string 1</SupplyText>
          </SupplyEntityModel>
          <SupplyEntityModel>
            <ChannelName>sample string 6</ChannelName>
            <CheckInDate>2025-04-28T17:29:54.4520639+00:00</CheckInDate>
            <ColorCode>None</ColorCode>
            <Guests>sample string 4</Guests>
            <LOS>sample string 3</LOS>
            <NoofProperties>7</NoofProperties>
            <ShopDateTime>2025-04-28T17:29:54.4520639+00:00</ShopDateTime>
            <ShortRateDescription>sample string 5</ShortRateDescription>
            <SupplyData>1</SupplyData>
            <SupplyText>sample string 1</SupplyText>
          </SupplyEntityModel>
        </SupplyEntityCollection>
      </SupplyContainerEntity>
      <SupplyContainerEntity>
        <ComponentName>sample string 1</ComponentName>
        <ComponentType>MySubscriberRate</ComponentType>
        <SupplyEntityCollection>
          <SupplyEntityModel>
            <ChannelName>sample string 6</ChannelName>
            <CheckInDate>2025-04-28T17:29:54.4520639+00:00</CheckInDate>
            <ColorCode>None</ColorCode>
            <Guests>sample string 4</Guests>
            <LOS>sample string 3</LOS>
            <NoofProperties>7</NoofProperties>
            <ShopDateTime>2025-04-28T17:29:54.4520639+00:00</ShopDateTime>
            <ShortRateDescription>sample string 5</ShortRateDescription>
            <SupplyData>1</SupplyData>
            <SupplyText>sample string 1</SupplyText>
          </SupplyEntityModel>
          <SupplyEntityModel>
            <ChannelName>sample string 6</ChannelName>
            <CheckInDate>2025-04-28T17:29:54.4520639+00:00</CheckInDate>
            <ColorCode>None</ColorCode>
            <Guests>sample string 4</Guests>
            <LOS>sample string 3</LOS>
            <NoofProperties>7</NoofProperties>
            <ShopDateTime>2025-04-28T17:29:54.4520639+00:00</ShopDateTime>
            <ShortRateDescription>sample string 5</ShortRateDescription>
            <SupplyData>1</SupplyData>
            <SupplyText>sample string 1</SupplyText>
          </SupplyEntityModel>
        </SupplyEntityCollection>
      </SupplyContainerEntity>
    </SupplyEntites>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfSupplyViewModelQzIzD0mn>