GET GetonDemandPendingReports?SID={SID}

Request Information

URI Parameters

Name	Description	Type	Additional information
SID		integer	Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfOptimaReports

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

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "BID": 1,
      "ChannelIDs": "sample string 2",
      "Channels": "sample string 3",
      "CheckInDate": "2025-04-28T17:29:50.1825189+00:00",
      "CompsetAvg": 1,
      "ConsumedShop": 5,
      "ConsumedStatus": "sample string 6",
      "CreatedDate": "2025-04-28T17:29:50.1981515+00:00",
      "Currency": "sample string 8",
      "DataSufficiency": 1.0,
      "PostMergeDataSufficiency": 1.0,
      "DataSufficiencyMessage": "sample string 9",
      "DaysOfData": 10,
      "DisabledChannels": "sample string 11",
      "EmailStatus": "sample string 12",
      "EstimatedConsumedShop": 13,
      "EstimatedGeneratedUTCTime": "2025-04-28T17:29:50.1981515+00:00",
      "ExcelFilePath": "sample string 14",
      "ExcelStatus": "sample string 15",
      "ExchangeCurrency": "sample string 16",
      "FeedReportPath": "sample string 17",
      "FeedStatus": "sample string 18",
      "FullDataXMLPath": "sample string 19",
      "GeneratedBy": "sample string 20",
      "Guests": 21,
      "Inclusions": [
        "sample string 1",
        "sample string 2"
      ],
      "IsUI": true,
      "LOS": "sample string 22",
      "MarketSupply": 1,
      "MigrationFailedCounts": 23,
      "ModifiedDate": "2025-04-28T17:29:50.1981515+00:00",
      "MonthwiseFileStatus": "sample string 25",
      "NextReportDate": "2025-04-28T17:29:50.1981515+00:00",
      "NotificationStatus": "sample string 27",
      "PaceViewFileStatus": "sample string 28",
      "PriceThreshold": 1,
      "ProductType": "sample string 29",
      "Promotion": true,
      "Properties": "sample string 30",
      "PropertyNames": "sample string 31",
      "Qualification": true,
      "RecipientEmail": "sample string 32",
      "ReportFilePath": "sample string 33",
      "ReportID": 34,
      "RequestType": 1,
      "Restriction": true,
      "SID": 35,
      "ScheduleID": "sample string 36",
      "ShoppedDateTime": "2025-04-28T17:29:50.1981515+00:00",
      "SiteTypeName": "sample string 38",
      "SubscriberName": "sample string 39",
      "Supply": 1,
      "TaxType": "sample string 40",
      "UniversalId": 41
    },
    {
      "BID": 1,
      "ChannelIDs": "sample string 2",
      "Channels": "sample string 3",
      "CheckInDate": "2025-04-28T17:29:50.1825189+00:00",
      "CompsetAvg": 1,
      "ConsumedShop": 5,
      "ConsumedStatus": "sample string 6",
      "CreatedDate": "2025-04-28T17:29:50.1981515+00:00",
      "Currency": "sample string 8",
      "DataSufficiency": 1.0,
      "PostMergeDataSufficiency": 1.0,
      "DataSufficiencyMessage": "sample string 9",
      "DaysOfData": 10,
      "DisabledChannels": "sample string 11",
      "EmailStatus": "sample string 12",
      "EstimatedConsumedShop": 13,
      "EstimatedGeneratedUTCTime": "2025-04-28T17:29:50.1981515+00:00",
      "ExcelFilePath": "sample string 14",
      "ExcelStatus": "sample string 15",
      "ExchangeCurrency": "sample string 16",
      "FeedReportPath": "sample string 17",
      "FeedStatus": "sample string 18",
      "FullDataXMLPath": "sample string 19",
      "GeneratedBy": "sample string 20",
      "Guests": 21,
      "Inclusions": [
        "sample string 1",
        "sample string 2"
      ],
      "IsUI": true,
      "LOS": "sample string 22",
      "MarketSupply": 1,
      "MigrationFailedCounts": 23,
      "ModifiedDate": "2025-04-28T17:29:50.1981515+00:00",
      "MonthwiseFileStatus": "sample string 25",
      "NextReportDate": "2025-04-28T17:29:50.1981515+00:00",
      "NotificationStatus": "sample string 27",
      "PaceViewFileStatus": "sample string 28",
      "PriceThreshold": 1,
      "ProductType": "sample string 29",
      "Promotion": true,
      "Properties": "sample string 30",
      "PropertyNames": "sample string 31",
      "Qualification": true,
      "RecipientEmail": "sample string 32",
      "ReportFilePath": "sample string 33",
      "ReportID": 34,
      "RequestType": 1,
      "Restriction": true,
      "SID": 35,
      "ScheduleID": "sample string 36",
      "ShoppedDateTime": "2025-04-28T17:29:50.1981515+00:00",
      "SiteTypeName": "sample string 38",
      "SubscriberName": "sample string 39",
      "Supply": 1,
      "TaxType": "sample string 40",
      "UniversalId": 41
    }
  ]
}

text/html

Sample:

{"Message":"sample string 1","Status":true,"Body":[{"BID":1,"ChannelIDs":"sample string 2","Channels":"sample string 3","CheckInDate":"2025-04-28T17:29:50.1825189+00:00","CompsetAvg":1,"ConsumedShop":5,"ConsumedStatus":"sample string 6","CreatedDate":"2025-04-28T17:29:50.1981515+00:00","Currency":"sample string 8","DataSufficiency":1.0,"PostMergeDataSufficiency":1.0,"DataSufficiencyMessage":"sample string 9","DaysOfData":10,"DisabledChannels":"sample string 11","EmailStatus":"sample string 12","EstimatedConsumedShop":13,"EstimatedGeneratedUTCTime":"2025-04-28T17:29:50.1981515+00:00","ExcelFilePath":"sample string 14","ExcelStatus":"sample string 15","ExchangeCurrency":"sample string 16","FeedReportPath":"sample string 17","FeedStatus":"sample string 18","FullDataXMLPath":"sample string 19","GeneratedBy":"sample string 20","Guests":21,"Inclusions":["sample string 1","sample string 2"],"IsUI":true,"LOS":"sample string 22","MarketSupply":1,"MigrationFailedCounts":23,"ModifiedDate":"2025-04-28T17:29:50.1981515+00:00","MonthwiseFileStatus":"sample string 25","NextReportDate":"2025-04-28T17:29:50.1981515+00:00","NotificationStatus":"sample string 27","PaceViewFileStatus":"sample string 28","PriceThreshold":1,"ProductType":"sample string 29","Promotion":true,"Properties":"sample string 30","PropertyNames":"sample string 31","Qualification":true,"RecipientEmail":"sample string 32","ReportFilePath":"sample string 33","ReportID":34,"RequestType":1,"Restriction":true,"SID":35,"ScheduleID":"sample string 36","ShoppedDateTime":"2025-04-28T17:29:50.1981515+00:00","SiteTypeName":"sample string 38","SubscriberName":"sample string 39","Supply":1,"TaxType":"sample string 40","UniversalId":41},{"BID":1,"ChannelIDs":"sample string 2","Channels":"sample string 3","CheckInDate":"2025-04-28T17:29:50.1825189+00:00","CompsetAvg":1,"ConsumedShop":5,"ConsumedStatus":"sample string 6","CreatedDate":"2025-04-28T17:29:50.1981515+00:00","Currency":"sample string 8","DataSufficiency":1.0,"PostMergeDataSufficiency":1.0,"DataSufficiencyMessage":"sample string 9","DaysOfData":10,"DisabledChannels":"sample string 11","EmailStatus":"sample string 12","EstimatedConsumedShop":13,"EstimatedGeneratedUTCTime":"2025-04-28T17:29:50.1981515+00:00","ExcelFilePath":"sample string 14","ExcelStatus":"sample string 15","ExchangeCurrency":"sample string 16","FeedReportPath":"sample string 17","FeedStatus":"sample string 18","FullDataXMLPath":"sample string 19","GeneratedBy":"sample string 20","Guests":21,"Inclusions":["sample string 1","sample string 2"],"IsUI":true,"LOS":"sample string 22","MarketSupply":1,"MigrationFailedCounts":23,"ModifiedDate":"2025-04-28T17:29:50.1981515+00:00","MonthwiseFileStatus":"sample string 25","NextReportDate":"2025-04-28T17:29:50.1981515+00:00","NotificationStatus":"sample string 27","PaceViewFileStatus":"sample string 28","PriceThreshold":1,"ProductType":"sample string 29","Promotion":true,"Properties":"sample string 30","PropertyNames":"sample string 31","Qualification":true,"RecipientEmail":"sample string 32","ReportFilePath":"sample string 33","ReportID":34,"RequestType":1,"Restriction":true,"SID":35,"ScheduleID":"sample string 36","ShoppedDateTime":"2025-04-28T17:29:50.1981515+00:00","SiteTypeName":"sample string 38","SubscriberName":"sample string 39","Supply":1,"TaxType":"sample string 40","UniversalId":41}]}

application/xml, text/xml

Sample:

<ResponseOfArrayOfOptimaReportsZI9Wf7I6 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/RG.Core.Entities">
    <d2p1:OptimaReports>
      <d2p1:BID>1</d2p1:BID>
      <d2p1:ChannelIDs>sample string 2</d2p1:ChannelIDs>
      <d2p1:Channels>sample string 3</d2p1:Channels>
      <d2p1:CheckInDate>2025-04-28T17:29:50.1825189+00:00</d2p1:CheckInDate>
      <d2p1:CompsetAvg>1</d2p1:CompsetAvg>
      <d2p1:ConsumedShop>5</d2p1:ConsumedShop>
      <d2p1:ConsumedStatus>sample string 6</d2p1:ConsumedStatus>
      <d2p1:CreatedDate>2025-04-28T17:29:50.1981515+00:00</d2p1:CreatedDate>
      <d2p1:Currency>sample string 8</d2p1:Currency>
      <d2p1:DataSufficiency>1</d2p1:DataSufficiency>
      <d2p1:DataSufficiencyMessage>sample string 9</d2p1:DataSufficiencyMessage>
      <d2p1:DaysOfData>10</d2p1:DaysOfData>
      <d2p1:DisabledChannels>sample string 11</d2p1:DisabledChannels>
      <d2p1:EmailStatus>sample string 12</d2p1:EmailStatus>
      <d2p1:EstimatedConsumedShop>13</d2p1:EstimatedConsumedShop>
      <d2p1:EstimatedGeneratedUTCTime>2025-04-28T17:29:50.1981515+00:00</d2p1:EstimatedGeneratedUTCTime>
      <d2p1:ExcelFilePath>sample string 14</d2p1:ExcelFilePath>
      <d2p1:ExcelStatus>sample string 15</d2p1:ExcelStatus>
      <d2p1:ExchangeCurrency>sample string 16</d2p1:ExchangeCurrency>
      <d2p1:FeedReportPath>sample string 17</d2p1:FeedReportPath>
      <d2p1:FeedStatus>sample string 18</d2p1:FeedStatus>
      <d2p1:FullDataXMLPath>sample string 19</d2p1:FullDataXMLPath>
      <d2p1:GeneratedBy>sample string 20</d2p1:GeneratedBy>
      <d2p1:Guests>21</d2p1:Guests>
      <d2p1:Inclusions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Inclusions>
      <d2p1:IsUI>true</d2p1:IsUI>
      <d2p1:LOS>sample string 22</d2p1:LOS>
      <d2p1:MarketSupply>1</d2p1:MarketSupply>
      <d2p1:MigrationFailedCounts>23</d2p1:MigrationFailedCounts>
      <d2p1:ModifiedDate>2025-04-28T17:29:50.1981515+00:00</d2p1:ModifiedDate>
      <d2p1:MonthwiseFileStatus>sample string 25</d2p1:MonthwiseFileStatus>
      <d2p1:NextReportDate>2025-04-28T17:29:50.1981515+00:00</d2p1:NextReportDate>
      <d2p1:NotificationStatus>sample string 27</d2p1:NotificationStatus>
      <d2p1:PaceViewFileStatus>sample string 28</d2p1:PaceViewFileStatus>
      <d2p1:PostMergeDataSufficiency>1</d2p1:PostMergeDataSufficiency>
      <d2p1:PriceThreshold>1</d2p1:PriceThreshold>
      <d2p1:ProductType>sample string 29</d2p1:ProductType>
      <d2p1:Promotion>true</d2p1:Promotion>
      <d2p1:Properties>sample string 30</d2p1:Properties>
      <d2p1:PropertyNames>sample string 31</d2p1:PropertyNames>
      <d2p1:Qualification>true</d2p1:Qualification>
      <d2p1:RecipientEmail>sample string 32</d2p1:RecipientEmail>
      <d2p1:ReportFilePath>sample string 33</d2p1:ReportFilePath>
      <d2p1:ReportID>34</d2p1:ReportID>
      <d2p1:RequestType>OnDemand</d2p1:RequestType>
      <d2p1:Restriction>true</d2p1:Restriction>
      <d2p1:SID>35</d2p1:SID>
      <d2p1:ScheduleID>sample string 36</d2p1:ScheduleID>
      <d2p1:ShoppedDateTime>2025-04-28T17:29:50.1981515+00:00</d2p1:ShoppedDateTime>
      <d2p1:SiteTypeName>sample string 38</d2p1:SiteTypeName>
      <d2p1:SubscriberName>sample string 39</d2p1:SubscriberName>
      <d2p1:Supply>1</d2p1:Supply>
      <d2p1:TaxType>sample string 40</d2p1:TaxType>
      <d2p1:UniversalId>41</d2p1:UniversalId>
    </d2p1:OptimaReports>
    <d2p1:OptimaReports>
      <d2p1:BID>1</d2p1:BID>
      <d2p1:ChannelIDs>sample string 2</d2p1:ChannelIDs>
      <d2p1:Channels>sample string 3</d2p1:Channels>
      <d2p1:CheckInDate>2025-04-28T17:29:50.1825189+00:00</d2p1:CheckInDate>
      <d2p1:CompsetAvg>1</d2p1:CompsetAvg>
      <d2p1:ConsumedShop>5</d2p1:ConsumedShop>
      <d2p1:ConsumedStatus>sample string 6</d2p1:ConsumedStatus>
      <d2p1:CreatedDate>2025-04-28T17:29:50.1981515+00:00</d2p1:CreatedDate>
      <d2p1:Currency>sample string 8</d2p1:Currency>
      <d2p1:DataSufficiency>1</d2p1:DataSufficiency>
      <d2p1:DataSufficiencyMessage>sample string 9</d2p1:DataSufficiencyMessage>
      <d2p1:DaysOfData>10</d2p1:DaysOfData>
      <d2p1:DisabledChannels>sample string 11</d2p1:DisabledChannels>
      <d2p1:EmailStatus>sample string 12</d2p1:EmailStatus>
      <d2p1:EstimatedConsumedShop>13</d2p1:EstimatedConsumedShop>
      <d2p1:EstimatedGeneratedUTCTime>2025-04-28T17:29:50.1981515+00:00</d2p1:EstimatedGeneratedUTCTime>
      <d2p1:ExcelFilePath>sample string 14</d2p1:ExcelFilePath>
      <d2p1:ExcelStatus>sample string 15</d2p1:ExcelStatus>
      <d2p1:ExchangeCurrency>sample string 16</d2p1:ExchangeCurrency>
      <d2p1:FeedReportPath>sample string 17</d2p1:FeedReportPath>
      <d2p1:FeedStatus>sample string 18</d2p1:FeedStatus>
      <d2p1:FullDataXMLPath>sample string 19</d2p1:FullDataXMLPath>
      <d2p1:GeneratedBy>sample string 20</d2p1:GeneratedBy>
      <d2p1:Guests>21</d2p1:Guests>
      <d2p1:Inclusions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Inclusions>
      <d2p1:IsUI>true</d2p1:IsUI>
      <d2p1:LOS>sample string 22</d2p1:LOS>
      <d2p1:MarketSupply>1</d2p1:MarketSupply>
      <d2p1:MigrationFailedCounts>23</d2p1:MigrationFailedCounts>
      <d2p1:ModifiedDate>2025-04-28T17:29:50.1981515+00:00</d2p1:ModifiedDate>
      <d2p1:MonthwiseFileStatus>sample string 25</d2p1:MonthwiseFileStatus>
      <d2p1:NextReportDate>2025-04-28T17:29:50.1981515+00:00</d2p1:NextReportDate>
      <d2p1:NotificationStatus>sample string 27</d2p1:NotificationStatus>
      <d2p1:PaceViewFileStatus>sample string 28</d2p1:PaceViewFileStatus>
      <d2p1:PostMergeDataSufficiency>1</d2p1:PostMergeDataSufficiency>
      <d2p1:PriceThreshold>1</d2p1:PriceThreshold>
      <d2p1:ProductType>sample string 29</d2p1:ProductType>
      <d2p1:Promotion>true</d2p1:Promotion>
      <d2p1:Properties>sample string 30</d2p1:Properties>
      <d2p1:PropertyNames>sample string 31</d2p1:PropertyNames>
      <d2p1:Qualification>true</d2p1:Qualification>
      <d2p1:RecipientEmail>sample string 32</d2p1:RecipientEmail>
      <d2p1:ReportFilePath>sample string 33</d2p1:ReportFilePath>
      <d2p1:ReportID>34</d2p1:ReportID>
      <d2p1:RequestType>OnDemand</d2p1:RequestType>
      <d2p1:Restriction>true</d2p1:Restriction>
      <d2p1:SID>35</d2p1:SID>
      <d2p1:ScheduleID>sample string 36</d2p1:ScheduleID>
      <d2p1:ShoppedDateTime>2025-04-28T17:29:50.1981515+00:00</d2p1:ShoppedDateTime>
      <d2p1:SiteTypeName>sample string 38</d2p1:SiteTypeName>
      <d2p1:SubscriberName>sample string 39</d2p1:SubscriberName>
      <d2p1:Supply>1</d2p1:Supply>
      <d2p1:TaxType>sample string 40</d2p1:TaxType>
      <d2p1:UniversalId>41</d2p1:UniversalId>
    </d2p1:OptimaReports>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfOptimaReportsZI9Wf7I6>