siteMaintenance Web Service

siteMaintenance

Click here for a complete list of operations.

getGeographicZonesByAreaID

Searches for geographic zones ids based on areaID

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/siteMaintenance.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/getGeographicZonesByAreaID"

<?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>
    <getGeographicZonesByAreaID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <areaID>string</areaID>
    </getGeographicZonesByAreaID>
  </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>
    <getGeographicZonesByAreaIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getGeographicZonesByAreaIDResult>
        <smArea>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <AreaAvgRevenue>double</AreaAvgRevenue>
          <AreaDesc>string</AreaDesc>
          <AreaId>string</AreaId>
          <AreaNumOfCalls>short</AreaNumOfCalls>
          <AreaTotalRevenue>double</AreaTotalRevenue>
          <AssignEmployee>string</AssignEmployee>
          <Crtd_dateTime>dateTime</Crtd_dateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <Lupd_Prog>string</Lupd_Prog>
          <Lupd_User>string</Lupd_User>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
        </smArea>
        <smArea>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <AreaAvgRevenue>double</AreaAvgRevenue>
          <AreaDesc>string</AreaDesc>
          <AreaId>string</AreaId>
          <AreaNumOfCalls>short</AreaNumOfCalls>
          <AreaTotalRevenue>double</AreaTotalRevenue>
          <AssignEmployee>string</AssignEmployee>
          <Crtd_dateTime>dateTime</Crtd_dateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <Lupd_Prog>string</Lupd_Prog>
          <Lupd_User>string</Lupd_User>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
        </smArea>
      </getGeographicZonesByAreaIDResult>
    </getGeographicZonesByAreaIDResponse>
  </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/siteMaintenance.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>
    <getGeographicZonesByAreaID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <areaID>string</areaID>
    </getGeographicZonesByAreaID>
  </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>
    <getGeographicZonesByAreaIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getGeographicZonesByAreaIDResult>
        <smArea>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <AreaAvgRevenue>double</AreaAvgRevenue>
          <AreaDesc>string</AreaDesc>
          <AreaId>string</AreaId>
          <AreaNumOfCalls>short</AreaNumOfCalls>
          <AreaTotalRevenue>double</AreaTotalRevenue>
          <AssignEmployee>string</AssignEmployee>
          <Crtd_dateTime>dateTime</Crtd_dateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <Lupd_Prog>string</Lupd_Prog>
          <Lupd_User>string</Lupd_User>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
        </smArea>
        <smArea>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <AreaAvgRevenue>double</AreaAvgRevenue>
          <AreaDesc>string</AreaDesc>
          <AreaId>string</AreaId>
          <AreaNumOfCalls>short</AreaNumOfCalls>
          <AreaTotalRevenue>double</AreaTotalRevenue>
          <AssignEmployee>string</AssignEmployee>
          <Crtd_dateTime>dateTime</Crtd_dateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <Lupd_Prog>string</Lupd_Prog>
          <Lupd_User>string</Lupd_User>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
        </smArea>
      </getGeographicZonesByAreaIDResult>
    </getGeographicZonesByAreaIDResponse>
  </soap12:Body>
</soap12:Envelope>