POST GenerateOndemandReport

Request Information

URI Parameters

None.

Body Parameters

ReportRequest
NameDescriptionTypeAdditional information
SID

integer

None.

ContactId

integer

None.

FirstCheckInDate

date

None.

DaysOfData

integer

None.

LOS

integer

None.

Occupancy

integer

None.

Properties

Collection of integer

None.

Sources

Collection of string

None.

AllProperties

Collection of integer

None.

AllSources

Collection of string

None.

EmailIds

Collection of string

None.

ContactName

string

None.

IsSupply

boolean

None.

Name

string

None.

Currency

string

None.

ReportSource

string

None.

RTRRInSecond

integer

None.

IsILOSApplicable

boolean

None.

IsOptimaTrial

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "SID": 1,
  "ContactId": 2,
  "FirstCheckInDate": "2025-04-28T17:04:22.0813326+00:00",
  "DaysOfData": 4,
  "LOS": 5,
  "Occupancy": 6,
  "Properties": [
    1,
    2
  ],
  "Sources": [
    "sample string 1",
    "sample string 2"
  ],
  "AllProperties": [
    1,
    2
  ],
  "AllSources": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailIds": [
    "sample string 1",
    "sample string 2"
  ],
  "ContactName": "sample string 7",
  "IsSupply": true,
  "Name": "sample string 9",
  "Currency": "sample string 10",
  "ReportSource": "sample string 11",
  "RTRRInSecond": 12,
  "IsILOSApplicable": true,
  "IsOptimaTrial": true
}

text/html

Sample:
{"SID":1,"ContactId":2,"FirstCheckInDate":"2025-04-28T17:04:22.0813326+00:00","DaysOfData":4,"LOS":5,"Occupancy":6,"Properties":[1,2],"Sources":["sample string 1","sample string 2"],"AllProperties":[1,2],"AllSources":["sample string 1","sample string 2"],"EmailIds":["sample string 1","sample string 2"],"ContactName":"sample string 7","IsSupply":true,"Name":"sample string 9","Currency":"sample string 10","ReportSource":"sample string 11","RTRRInSecond":12,"IsILOSApplicable":true,"IsOptimaTrial":true}

application/xml, text/xml

Sample:
<ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Shopping">
  <AllProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AllProperties>
  <AllSources xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AllSources>
  <ContactId>2</ContactId>
  <ContactName>sample string 7</ContactName>
  <Currency>sample string 10</Currency>
  <DaysOfData>4</DaysOfData>
  <EmailIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailIds>
  <FirstCheckInDate>2025-04-28T17:04:22.0813326+00:00</FirstCheckInDate>
  <IsILOSApplicable>true</IsILOSApplicable>
  <IsOptimaTrial>true</IsOptimaTrial>
  <IsSupply>true</IsSupply>
  <LOS>5</LOS>
  <Name>sample string 9</Name>
  <Occupancy>6</Occupancy>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Properties>
  <RTRRInSecond>12</RTRRInSecond>
  <ReportSource>sample string 11</ReportSource>
  <SID>1</SID>
  <Sources xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Sources>
</ReportRequest>

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

Response Information

Resource Description

ResponseOfInt64
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": 3
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":3}

application/xml, text/xml

Sample:
<ResponseOflong xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body>3</Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOflong>