siteMaintenance


Click here for a complete list of operations.

getNewscreen

Gets a new default screen 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/getNewscreen"

<?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>
    <getNewscreen xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <myCustomer>
          <custContacts>
            <xsd:schema>schema</xsd:schema>xml</custContacts>
          <businessRuleViolations>
            <businessRuleViolation xsi:nil="true" />
            <businessRuleViolation xsi:nil="true" />
          </businessRuleViolations>
          <addresses>
            <address xsi:nil="true" />
            <address xsi:nil="true" />
          </addresses>
        </myCustomer>
        <myItemScreens>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
        </myItemScreens>
        <customerNote>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <dtRevisedDate>dateTime</dtRevisedDate>
          <nID>int</nID>
          <sLevelName>string</sLevelName>
          <sTableName>string</sTableName>
          <sNoteText>string</sNoteText>
        </customerNote>
      </inTemplate>
    </getNewscreen>
  </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>
    <getNewscreenResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewscreenResult>
        <errorMessage>string</errorMessage>
        <myCustomer>
          <custContacts>
            <xsd:schema>schema</xsd:schema>xml</custContacts>
          <businessRuleViolations>
            <businessRuleViolation xsi:nil="true" />
            <businessRuleViolation xsi:nil="true" />
          </businessRuleViolations>
          <addresses>
            <address xsi:nil="true" />
            <address xsi:nil="true" />
          </addresses>
        </myCustomer>
        <myItemScreens>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
        </myItemScreens>
        <customerNote>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <dtRevisedDate>dateTime</dtRevisedDate>
          <nID>int</nID>
          <sLevelName>string</sLevelName>
          <sTableName>string</sTableName>
          <sNoteText>string</sNoteText>
        </customerNote>
      </getNewscreenResult>
    </getNewscreenResponse>
  </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>
    <getNewscreen xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <myCustomer>
          <custContacts>
            <xsd:schema>schema</xsd:schema>xml</custContacts>
          <businessRuleViolations>
            <businessRuleViolation xsi:nil="true" />
            <businessRuleViolation xsi:nil="true" />
          </businessRuleViolations>
          <addresses>
            <address xsi:nil="true" />
            <address xsi:nil="true" />
          </addresses>
        </myCustomer>
        <myItemScreens>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
        </myItemScreens>
        <customerNote>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <dtRevisedDate>dateTime</dtRevisedDate>
          <nID>int</nID>
          <sLevelName>string</sLevelName>
          <sTableName>string</sTableName>
          <sNoteText>string</sNoteText>
        </customerNote>
      </inTemplate>
    </getNewscreen>
  </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>
    <getNewscreenResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewscreenResult>
        <errorMessage>string</errorMessage>
        <myCustomer>
          <custContacts>
            <xsd:schema>schema</xsd:schema>xml</custContacts>
          <businessRuleViolations>
            <businessRuleViolation xsi:nil="true" />
            <businessRuleViolation xsi:nil="true" />
          </businessRuleViolations>
          <addresses>
            <address xsi:nil="true" />
            <address xsi:nil="true" />
          </addresses>
        </myCustomer>
        <myItemScreens>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
          <itemScreen>
            <errorMessage>string</errorMessage>
            <mySOAddress xsi:nil="true" />
            <mySMSOAddress xsi:nil="true" />
            <soAddressNote xsi:nil="true" />
          </itemScreen>
        </myItemScreens>
        <customerNote>
          <errorMessage>string</errorMessage>
          <resultCode>int</resultCode>
          <dtRevisedDate>dateTime</dtRevisedDate>
          <nID>int</nID>
          <sLevelName>string</sLevelName>
          <sTableName>string</sTableName>
          <sNoteText>string</sNoteText>
        </customerNote>
      </getNewscreenResult>
    </getNewscreenResponse>
  </soap12:Body>
</soap12:Envelope>