siteMaintenance Web Service

siteMaintenance

Click here for a complete list of operations.

getNewsmSOAddress

Gets a new default smSOAddress based on the passed template

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/getNewsmSOAddress"

<?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>
    <getNewsmSOAddress xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <BlanketPONbr>string</BlanketPONbr>
        <BranchID>string</BranchID>
        <CreatedBy>string</CreatedBy>
        <CreatedDate>dateTime</CreatedDate>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_User>string</Crtd_User>
        <Ctrd_Prog>string</Ctrd_Prog>
        <CustID>string</CustID>
        <DefaultCallType>string</DefaultCallType>
        <DefaultPrcPlanID>string</DefaultPrcPlanID>
        <DefaultProjManager>string</DefaultProjManager>
        <DefaultPytMethod>string</DefaultPytMethod>
        <DefaultSalesPerson>string</DefaultSalesPerson>
        <DefaultStatusID>string</DefaultStatusID>
        <DefaultTechnician>string</DefaultTechnician>
        <DwellingType>string</DwellingType>
        <GeographicZone>string</GeographicZone>
        <LabMarkupID>string</LabMarkupID>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
        <Lupd_DateTime>dateTime</Lupd_DateTime>
        <Lupd_Prog>string</Lupd_Prog>
        <Lupd_User>string</Lupd_User>
        <MapCoordinates>string</MapCoordinates>
        <MapPage>string</MapPage>
        <MatMarkupID>string</MatMarkupID>
        <MaxServAmount>double</MaxServAmount>
        <OriginalMediaID>string</OriginalMediaID>
        <POEndDate>dateTime</POEndDate>
        <POStartDate>dateTime</POStartDate>
        <POOption>string</POOption>
        <PrintFlag>short</PrintFlag>
        <Priority>string</Priority>
        <RouteID>string</RouteID>
        <SecurityEntryCode>string</SecurityEntryCode>
        <ShiptoID>string</ShiptoID>
        <Sub>string</Sub>
        <TaxID>string</TaxID>
        <TenantAuthorizeCall>string</TenantAuthorizeCall>
        <TImeZone>string</TImeZone>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </inTemplate>
    </getNewsmSOAddress>
  </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>
    <getNewsmSOAddressResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewsmSOAddressResult>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <BlanketPONbr>string</BlanketPONbr>
        <BranchID>string</BranchID>
        <CreatedBy>string</CreatedBy>
        <CreatedDate>dateTime</CreatedDate>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_User>string</Crtd_User>
        <Ctrd_Prog>string</Ctrd_Prog>
        <CustID>string</CustID>
        <DefaultCallType>string</DefaultCallType>
        <DefaultPrcPlanID>string</DefaultPrcPlanID>
        <DefaultProjManager>string</DefaultProjManager>
        <DefaultPytMethod>string</DefaultPytMethod>
        <DefaultSalesPerson>string</DefaultSalesPerson>
        <DefaultStatusID>string</DefaultStatusID>
        <DefaultTechnician>string</DefaultTechnician>
        <DwellingType>string</DwellingType>
        <GeographicZone>string</GeographicZone>
        <LabMarkupID>string</LabMarkupID>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
        <Lupd_DateTime>dateTime</Lupd_DateTime>
        <Lupd_Prog>string</Lupd_Prog>
        <Lupd_User>string</Lupd_User>
        <MapCoordinates>string</MapCoordinates>
        <MapPage>string</MapPage>
        <MatMarkupID>string</MatMarkupID>
        <MaxServAmount>double</MaxServAmount>
        <OriginalMediaID>string</OriginalMediaID>
        <POEndDate>dateTime</POEndDate>
        <POStartDate>dateTime</POStartDate>
        <POOption>string</POOption>
        <PrintFlag>short</PrintFlag>
        <Priority>string</Priority>
        <RouteID>string</RouteID>
        <SecurityEntryCode>string</SecurityEntryCode>
        <ShiptoID>string</ShiptoID>
        <Sub>string</Sub>
        <TaxID>string</TaxID>
        <TenantAuthorizeCall>string</TenantAuthorizeCall>
        <TImeZone>string</TImeZone>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </getNewsmSOAddressResult>
    </getNewsmSOAddressResponse>
  </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>
    <getNewsmSOAddress xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <BlanketPONbr>string</BlanketPONbr>
        <BranchID>string</BranchID>
        <CreatedBy>string</CreatedBy>
        <CreatedDate>dateTime</CreatedDate>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_User>string</Crtd_User>
        <Ctrd_Prog>string</Ctrd_Prog>
        <CustID>string</CustID>
        <DefaultCallType>string</DefaultCallType>
        <DefaultPrcPlanID>string</DefaultPrcPlanID>
        <DefaultProjManager>string</DefaultProjManager>
        <DefaultPytMethod>string</DefaultPytMethod>
        <DefaultSalesPerson>string</DefaultSalesPerson>
        <DefaultStatusID>string</DefaultStatusID>
        <DefaultTechnician>string</DefaultTechnician>
        <DwellingType>string</DwellingType>
        <GeographicZone>string</GeographicZone>
        <LabMarkupID>string</LabMarkupID>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
        <Lupd_DateTime>dateTime</Lupd_DateTime>
        <Lupd_Prog>string</Lupd_Prog>
        <Lupd_User>string</Lupd_User>
        <MapCoordinates>string</MapCoordinates>
        <MapPage>string</MapPage>
        <MatMarkupID>string</MatMarkupID>
        <MaxServAmount>double</MaxServAmount>
        <OriginalMediaID>string</OriginalMediaID>
        <POEndDate>dateTime</POEndDate>
        <POStartDate>dateTime</POStartDate>
        <POOption>string</POOption>
        <PrintFlag>short</PrintFlag>
        <Priority>string</Priority>
        <RouteID>string</RouteID>
        <SecurityEntryCode>string</SecurityEntryCode>
        <ShiptoID>string</ShiptoID>
        <Sub>string</Sub>
        <TaxID>string</TaxID>
        <TenantAuthorizeCall>string</TenantAuthorizeCall>
        <TImeZone>string</TImeZone>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </inTemplate>
    </getNewsmSOAddress>
  </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>
    <getNewsmSOAddressResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewsmSOAddressResult>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <BlanketPONbr>string</BlanketPONbr>
        <BranchID>string</BranchID>
        <CreatedBy>string</CreatedBy>
        <CreatedDate>dateTime</CreatedDate>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_User>string</Crtd_User>
        <Ctrd_Prog>string</Ctrd_Prog>
        <CustID>string</CustID>
        <DefaultCallType>string</DefaultCallType>
        <DefaultPrcPlanID>string</DefaultPrcPlanID>
        <DefaultProjManager>string</DefaultProjManager>
        <DefaultPytMethod>string</DefaultPytMethod>
        <DefaultSalesPerson>string</DefaultSalesPerson>
        <DefaultStatusID>string</DefaultStatusID>
        <DefaultTechnician>string</DefaultTechnician>
        <DwellingType>string</DwellingType>
        <GeographicZone>string</GeographicZone>
        <LabMarkupID>string</LabMarkupID>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
        <Lupd_DateTime>dateTime</Lupd_DateTime>
        <Lupd_Prog>string</Lupd_Prog>
        <Lupd_User>string</Lupd_User>
        <MapCoordinates>string</MapCoordinates>
        <MapPage>string</MapPage>
        <MatMarkupID>string</MatMarkupID>
        <MaxServAmount>double</MaxServAmount>
        <OriginalMediaID>string</OriginalMediaID>
        <POEndDate>dateTime</POEndDate>
        <POStartDate>dateTime</POStartDate>
        <POOption>string</POOption>
        <PrintFlag>short</PrintFlag>
        <Priority>string</Priority>
        <RouteID>string</RouteID>
        <SecurityEntryCode>string</SecurityEntryCode>
        <ShiptoID>string</ShiptoID>
        <Sub>string</Sub>
        <TaxID>string</TaxID>
        <TenantAuthorizeCall>string</TenantAuthorizeCall>
        <TImeZone>string</TImeZone>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </getNewsmSOAddressResult>
    </getNewsmSOAddressResponse>
  </soap12:Body>
</soap12:Envelope>