GET GetViolationSummary?SID={SID}&CheckInStartDate={CheckInStartDate}&CheckInEndDate={CheckInEndDate}&LOS={LOS}&Guest={Guest}&Promotion={Promotion}&Qualification={Qualification}&Restriction={Restriction}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SID

integer

Required

CheckInStartDate

date

Required

CheckInEndDate

date

Required

LOS

integer

Required

Guest

integer

Required

Promotion

string

Required

Qualification

string

Required

Restriction

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfViolationSummaryEntity
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

Collection of ViolationSummaryEntity

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "SiteMetaTypeID": 1,
      "SiteMetaTypeName": "sample string 2",
      "TotalShop": 3,
      "AvailabilityViolationsCount": 4,
      "RateViolationsCount": 5,
      "BenchmarkMinRate": 6.0,
      "BenchmarkMaxRate": 7.0,
      "BrandRate": 8.0,
      "ViolationsDateCount": 9,
      "ViolationsDateCountPercent": 10.0,
      "ShopDateTime": "2025-04-28T17:04:21.2845135+00:00"
    },
    {
      "SiteMetaTypeID": 1,
      "SiteMetaTypeName": "sample string 2",
      "TotalShop": 3,
      "AvailabilityViolationsCount": 4,
      "RateViolationsCount": 5,
      "BenchmarkMinRate": 6.0,
      "BenchmarkMaxRate": 7.0,
      "BrandRate": 8.0,
      "ViolationsDateCount": 9,
      "ViolationsDateCountPercent": 10.0,
      "ShopDateTime": "2025-04-28T17:04:21.2845135+00:00"
    }
  ]
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":[{"SiteMetaTypeID":1,"SiteMetaTypeName":"sample string 2","TotalShop":3,"AvailabilityViolationsCount":4,"RateViolationsCount":5,"BenchmarkMinRate":6.0,"BenchmarkMaxRate":7.0,"BrandRate":8.0,"ViolationsDateCount":9,"ViolationsDateCountPercent":10.0,"ShopDateTime":"2025-04-28T17:04:21.2845135+00:00"},{"SiteMetaTypeID":1,"SiteMetaTypeName":"sample string 2","TotalShop":3,"AvailabilityViolationsCount":4,"RateViolationsCount":5,"BenchmarkMinRate":6.0,"BenchmarkMaxRate":7.0,"BrandRate":8.0,"ViolationsDateCount":9,"ViolationsDateCountPercent":10.0,"ShopDateTime":"2025-04-28T17:04:21.2845135+00:00"}]}

application/xml, text/xml

Sample:
<ResponseOfArrayOfViolationSummaryEntityQzIzD0mn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body>
    <ViolationSummaryEntity>
      <AvailabilityViolationsCount>4</AvailabilityViolationsCount>
      <BenchmarkMaxRate>7</BenchmarkMaxRate>
      <BenchmarkMinRate>6</BenchmarkMinRate>
      <BrandRate>8</BrandRate>
      <RateViolationsCount>5</RateViolationsCount>
      <ShopDateTime>2025-04-28T17:04:21.2845135+00:00</ShopDateTime>
      <SiteMetaTypeID>1</SiteMetaTypeID>
      <SiteMetaTypeName>sample string 2</SiteMetaTypeName>
      <TotalShop>3</TotalShop>
      <ViolationsDateCount>9</ViolationsDateCount>
      <ViolationsDateCountPercent>10</ViolationsDateCountPercent>
    </ViolationSummaryEntity>
    <ViolationSummaryEntity>
      <AvailabilityViolationsCount>4</AvailabilityViolationsCount>
      <BenchmarkMaxRate>7</BenchmarkMaxRate>
      <BenchmarkMinRate>6</BenchmarkMinRate>
      <BrandRate>8</BrandRate>
      <RateViolationsCount>5</RateViolationsCount>
      <ShopDateTime>2025-04-28T17:04:21.2845135+00:00</ShopDateTime>
      <SiteMetaTypeID>1</SiteMetaTypeID>
      <SiteMetaTypeName>sample string 2</SiteMetaTypeName>
      <TotalShop>3</TotalShop>
      <ViolationsDateCount>9</ViolationsDateCount>
      <ViolationsDateCountPercent>10</ViolationsDateCountPercent>
    </ViolationSummaryEntity>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfViolationSummaryEntityQzIzD0mn>