Open the Portico Developer Guide site
PosGateway Schema
PosReportSearchReqType Complex Type
PosGateway Schema : PosReportSearchReqType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
TzConversion Element Criteria Element DeviceId Element RptEndUtcDT Element RptStartUtcDT Element ReturnHeaderOnly Element All PosReportSearchReqType Complex Type
Overview
All
ReturnHeaderOnly booleanType Simple Type

Indicates whether the report header containing transaction count information matching the given search criteria is the only information returned; default is 'N'.

RptStartUtcDT optional xs:dateTime

Start date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, start date time will be defaulted to six days prior at 00:00:00.

Transactions must have been run at or after this time to be returned.

RptEndUtcDT optional xs:dateTime

End date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, end date time will be defaulted to tomorrow at 00:00:00.

Transactions must have been run before or at this time to be returned.

Note: The end date/time must be after the start date/time.

DeviceId optional deviceIdType Simple Type

Device identifier used to filter the report results to a particular device.

Criteria ReportSearchCriteriaType Complex Type

Report search criteria options.

Choice
All
SiteTrace siteTraceType Simple Type

SiteTrace used to filter report results; originally provided in the request header

TzConversion optional tzoneConversionType Simple Type

Indicates that a time zone conversion should be applied to dates/times in the response; see the associated Type enumerations for specific values supported.

Used By
ReportSearch Element
Source
<xs:complexType name="PosReportSearchReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="ReturnHeaderOnly" type="booleanType">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether the report header containing transaction count information matching the given search criteria is the only information returned; default is 'N'.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RptStartUtcDT" type="xs:dateTime" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Start date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, start date time will be defaulted to six days prior at 00:00:00.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Transactions must have been run at or after this time to be returned.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RptEndUtcDT" type="xs:dateTime" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">End date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, end date time will be defaulted to tomorrow at 00:00:00.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Transactions must have been run before or at this time to be returned.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> The end date/time must be after the start date/time.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="DeviceId" type="deviceIdType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Device identifier used to filter the report results to a particular device.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="Criteria" type="ReportSearchCriteriaType">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Report search criteria options.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TzConversion" type="tzoneConversionType" default="UTC" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates that a time zone conversion should be applied to dates/times in the response; see the associated Type enumerations for specific values supported.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>
See Also
PosGateway Schema