quickQuery Web Service

quickQuery

Click here for a complete list of operations.

getQueryViewsByID

Searches for query views by the query view name

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /ctapi/services/ctDynamicsSL/quickQuery.asmx HTTP/1.1
Host: www.catalinatechnology.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.catalinatechnology.com/services/ctDynamicsSL/getQueryViewsByID"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap:Header>
  <soap:Body>
    <getQueryViewsByID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <queryViewName>string</queryViewName>
    </getQueryViewsByID>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getQueryViewsByIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getQueryViewsByIDResult>
        <vs_qvcatalog>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <SQLView>string</SQLView>
          <BaseQueryView>string</BaseQueryView>
          <QueryViewName>string</QueryViewName>
          <Module>string</Module>
          <Number>string</Number>
          <ViewDescription>string</ViewDescription>
          <ViewFilter>string</ViewFilter>
          <ViewSort>string</ViewSort>
          <ColumnsRemovedMoved>string</ColumnsRemovedMoved>
          <DrillPrograms>string</DrillPrograms>
          <VisibilityType>short</VisibilityType>
          <Visibility>string</Visibility>
          <SystemDatabase>short</SystemDatabase>
          <CompanyColumn>string</CompanyColumn>
          <CompanyParms>short</CompanyParms>
          <NoteColumns>string</NoteColumns>
          <CreatedBy>string</CreatedBy>
        </vs_qvcatalog>
        <vs_qvcatalog>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <SQLView>string</SQLView>
          <BaseQueryView>string</BaseQueryView>
          <QueryViewName>string</QueryViewName>
          <Module>string</Module>
          <Number>string</Number>
          <ViewDescription>string</ViewDescription>
          <ViewFilter>string</ViewFilter>
          <ViewSort>string</ViewSort>
          <ColumnsRemovedMoved>string</ColumnsRemovedMoved>
          <DrillPrograms>string</DrillPrograms>
          <VisibilityType>short</VisibilityType>
          <Visibility>string</Visibility>
          <SystemDatabase>short</SystemDatabase>
          <CompanyColumn>string</CompanyColumn>
          <CompanyParms>short</CompanyParms>
          <NoteColumns>string</NoteColumns>
          <CreatedBy>string</CreatedBy>
        </vs_qvcatalog>
      </getQueryViewsByIDResult>
    </getQueryViewsByIDResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ctapi/services/ctDynamicsSL/quickQuery.asmx HTTP/1.1
Host: www.catalinatechnology.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap12:Header>
  <soap12:Body>
    <getQueryViewsByID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <queryViewName>string</queryViewName>
    </getQueryViewsByID>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getQueryViewsByIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getQueryViewsByIDResult>
        <vs_qvcatalog>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <SQLView>string</SQLView>
          <BaseQueryView>string</BaseQueryView>
          <QueryViewName>string</QueryViewName>
          <Module>string</Module>
          <Number>string</Number>
          <ViewDescription>string</ViewDescription>
          <ViewFilter>string</ViewFilter>
          <ViewSort>string</ViewSort>
          <ColumnsRemovedMoved>string</ColumnsRemovedMoved>
          <DrillPrograms>string</DrillPrograms>
          <VisibilityType>short</VisibilityType>
          <Visibility>string</Visibility>
          <SystemDatabase>short</SystemDatabase>
          <CompanyColumn>string</CompanyColumn>
          <CompanyParms>short</CompanyParms>
          <NoteColumns>string</NoteColumns>
          <CreatedBy>string</CreatedBy>
        </vs_qvcatalog>
        <vs_qvcatalog>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <SQLView>string</SQLView>
          <BaseQueryView>string</BaseQueryView>
          <QueryViewName>string</QueryViewName>
          <Module>string</Module>
          <Number>string</Number>
          <ViewDescription>string</ViewDescription>
          <ViewFilter>string</ViewFilter>
          <ViewSort>string</ViewSort>
          <ColumnsRemovedMoved>string</ColumnsRemovedMoved>
          <DrillPrograms>string</DrillPrograms>
          <VisibilityType>short</VisibilityType>
          <Visibility>string</Visibility>
          <SystemDatabase>short</SystemDatabase>
          <CompanyColumn>string</CompanyColumn>
          <CompanyParms>short</CompanyParms>
          <NoteColumns>string</NoteColumns>
          <CreatedBy>string</CreatedBy>
        </vs_qvcatalog>
      </getQueryViewsByIDResult>
    </getQueryViewsByIDResponse>
  </soap12:Body>
</soap12:Envelope>