GET GetReportData?reportId={reportId}&SID={SID}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
reportId | integer |
Required |
|
SID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseOfReportDataName | Description | Type | Additional information |
---|---|---|---|
Message | string |
None. |
|
Status | boolean |
None. |
|
Body | ReportData |
None. |
Response Formats
application/json, text/json
Sample:
{ "Message": "sample string 1", "Status": true, "Body": { "Channels": "sample string 1", "ExcelLiteFilePath": "sample string 2", "CheckInDate": "2025-04-28T16:21:00.5445322+00:00", "ConsumedShop": 4, "CompsetAvg": 1, "Currency": "sample string 5", "DataSufficiency": 1.0, "DataSufficiencyMessage": "sample string 6", "DaysOfData": 7, "DisabledChannels": "sample string 8", "Occupancy": 9, "ModifiedDate": "2025-04-28T16:21:00.5445322+00:00", "MonthwiseFileStatus": "sample string 11", "NotificationStatus": "sample string 12", "PaceViewFileStatus": "sample string 13", "PriceThreshold": 1, "Properties": "sample string 14", "ReportFilePath": "sample string 15", "ReportID": 16, "RequestType": "sample string 17", "SID": 18, "ShoppedDateTime": "sample string 19", "FullCheckinDate": "sample string 20", "SiteTypeName": "sample string 21", "LOS": "sample string 22", "NextReportDate": "sample string 23", "Supply": 1, "GeneratedBy": "sample string 24" } }
text/html
Sample:
{"Message":"sample string 1","Status":true,"Body":{"Channels":"sample string 1","ExcelLiteFilePath":"sample string 2","CheckInDate":"2025-04-28T16:21:00.5445322+00:00","ConsumedShop":4,"CompsetAvg":1,"Currency":"sample string 5","DataSufficiency":1.0,"DataSufficiencyMessage":"sample string 6","DaysOfData":7,"DisabledChannels":"sample string 8","Occupancy":9,"ModifiedDate":"2025-04-28T16:21:00.5445322+00:00","MonthwiseFileStatus":"sample string 11","NotificationStatus":"sample string 12","PaceViewFileStatus":"sample string 13","PriceThreshold":1,"Properties":"sample string 14","ReportFilePath":"sample string 15","ReportID":16,"RequestType":"sample string 17","SID":18,"ShoppedDateTime":"sample string 19","FullCheckinDate":"sample string 20","SiteTypeName":"sample string 21","LOS":"sample string 22","NextReportDate":"sample string 23","Supply":1,"GeneratedBy":"sample string 24"}}
application/xml, text/xml
Sample:
<ResponseOfReportData_Sjhcpq24 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.DownloadReport"> <d2p1:Channels>sample string 1</d2p1:Channels> <d2p1:CheckInDate>2025-04-28T16:21:00.5445322+00:00</d2p1:CheckInDate> <d2p1:CompsetAvg>1</d2p1:CompsetAvg> <d2p1:ConsumedShop>4</d2p1:ConsumedShop> <d2p1:Currency>sample string 5</d2p1:Currency> <d2p1:DataSufficiency>1</d2p1:DataSufficiency> <d2p1:DataSufficiencyMessage>sample string 6</d2p1:DataSufficiencyMessage> <d2p1:DaysOfData>7</d2p1:DaysOfData> <d2p1:DisabledChannels>sample string 8</d2p1:DisabledChannels> <d2p1:ExcelLiteFilePath>sample string 2</d2p1:ExcelLiteFilePath> <d2p1:FullCheckinDate>sample string 20</d2p1:FullCheckinDate> <d2p1:GeneratedBy>sample string 24</d2p1:GeneratedBy> <d2p1:LOS>sample string 22</d2p1:LOS> <d2p1:ModifiedDate>2025-04-28T16:21:00.5445322+00:00</d2p1:ModifiedDate> <d2p1:MonthwiseFileStatus>sample string 11</d2p1:MonthwiseFileStatus> <d2p1:NextReportDate>sample string 23</d2p1:NextReportDate> <d2p1:NotificationStatus>sample string 12</d2p1:NotificationStatus> <d2p1:Occupancy>9</d2p1:Occupancy> <d2p1:PaceViewFileStatus>sample string 13</d2p1:PaceViewFileStatus> <d2p1:PriceThreshold>1</d2p1:PriceThreshold> <d2p1:Properties>sample string 14</d2p1:Properties> <d2p1:ReportFilePath>sample string 15</d2p1:ReportFilePath> <d2p1:ReportID>16</d2p1:ReportID> <d2p1:RequestType>sample string 17</d2p1:RequestType> <d2p1:SID>18</d2p1:SID> <d2p1:ShoppedDateTime>sample string 19</d2p1:ShoppedDateTime> <d2p1:SiteTypeName>sample string 21</d2p1:SiteTypeName> <d2p1:Supply>1</d2p1:Supply> </Body> <Message>sample string 1</Message> <Status>true</Status> </ResponseOfReportData_Sjhcpq24>