POST GetSolarSearchResult

Request Information

URI Parameters

None.

Body Parameters

SolarRequest
NameDescriptionTypeAdditional information
DaysOfData

integer

None.

Inclusive1

string

None.

Inclusive2

string

None.

Inclusive3

string

None.

Exclusive

string

None.

StartIndex

integer

None.

NumberOfRows

integer

None.

Properties

Collection of integer

None.

Channels

Collection of string

None.

ApplyRule

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "DaysOfData": 1,
  "Inclusive1": "sample string 2",
  "Inclusive2": "sample string 3",
  "Inclusive3": "sample string 4",
  "Exclusive": "sample string 5",
  "StartIndex": 6,
  "NumberOfRows": 7,
  "Properties": [
    1,
    2
  ],
  "Channels": [
    "sample string 1",
    "sample string 2"
  ],
  "ApplyRule": true
}

text/html

Sample:
{"DaysOfData":1,"Inclusive1":"sample string 2","Inclusive2":"sample string 3","Inclusive3":"sample string 4","Exclusive":"sample string 5","StartIndex":6,"NumberOfRows":7,"Properties":[1,2],"Channels":["sample string 1","sample string 2"],"ApplyRule":true}

application/xml, text/xml

Sample:
<SolarRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.TagMapping">
  <ApplyRule>true</ApplyRule>
  <Channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Channels>
  <DaysOfData>1</DaysOfData>
  <Exclusive>sample string 5</Exclusive>
  <Inclusive1>sample string 2</Inclusive1>
  <Inclusive2>sample string 3</Inclusive2>
  <Inclusive3>sample string 4</Inclusive3>
  <NumberOfRows>7</NumberOfRows>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Properties>
  <StartIndex>6</StartIndex>
</SolarRequest>

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

Response Information

Resource Description

ResponseOfListOfRateTuple
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

Collection of RateTuple

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "propertyid": "sample string 1",
      "channelid": "sample string 2",
      "roomdescription": "sample string 3",
      "last_modified": "sample string 4"
    },
    {
      "propertyid": "sample string 1",
      "channelid": "sample string 2",
      "roomdescription": "sample string 3",
      "last_modified": "sample string 4"
    }
  ]
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":[{"propertyid":"sample string 1","channelid":"sample string 2","roomdescription":"sample string 3","last_modified":"sample string 4"},{"propertyid":"sample string 1","channelid":"sample string 2","roomdescription":"sample string 3","last_modified":"sample string 4"}]}

application/xml, text/xml

Sample:
<ResponseOfArrayOfRateTupleu_PXb4S2D xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.TagMapping">
    <d2p1:RateTuple>
      <d2p1:ChannelId>sample string 2</d2p1:ChannelId>
      <d2p1:LastModified>sample string 4</d2p1:LastModified>
      <d2p1:PropertyId>sample string 1</d2p1:PropertyId>
      <d2p1:RoomDescription>sample string 3</d2p1:RoomDescription>
    </d2p1:RateTuple>
    <d2p1:RateTuple>
      <d2p1:ChannelId>sample string 2</d2p1:ChannelId>
      <d2p1:LastModified>sample string 4</d2p1:LastModified>
      <d2p1:PropertyId>sample string 1</d2p1:PropertyId>
      <d2p1:RoomDescription>sample string 3</d2p1:RoomDescription>
    </d2p1:RateTuple>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfRateTupleu_PXb4S2D>