common Web Service

common

Click here for a complete list of operations.

getNewDSLXML

get a blank DSLXML object

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/common.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/getNewDSLXML"

<?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>
    <getNewDSLXML xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <xmlGUID>string</xmlGUID>
        <siteID>string</siteID>
        <itemID>string</itemID>
        <itemType>string</itemType>
        <status>string</status>
        <createdDate>dateTime</createdDate>
        <lastUpdated>dateTime</lastUpdated>
        <xmlContent>string</xmlContent>
        <user1>string</user1>
        <user2>string</user2>
        <user3>double</user3>
        <user4>double</user4>
        <user5>string</user5>
        <user6>string</user6>
        <user7>dateTime</user7>
        <user8>dateTime</user8>
        <user9>short</user9>
        <user10>short</user10>
        <user11>string</user11>
      </inTemplate>
    </getNewDSLXML>
  </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>
    <getNewDSLXMLResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewDSLXMLResult>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <xmlGUID>string</xmlGUID>
        <siteID>string</siteID>
        <itemID>string</itemID>
        <itemType>string</itemType>
        <status>string</status>
        <createdDate>dateTime</createdDate>
        <lastUpdated>dateTime</lastUpdated>
        <xmlContent>string</xmlContent>
        <user1>string</user1>
        <user2>string</user2>
        <user3>double</user3>
        <user4>double</user4>
        <user5>string</user5>
        <user6>string</user6>
        <user7>dateTime</user7>
        <user8>dateTime</user8>
        <user9>short</user9>
        <user10>short</user10>
        <user11>string</user11>
      </getNewDSLXMLResult>
    </getNewDSLXMLResponse>
  </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/common.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>
    <getNewDSLXML xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <xmlGUID>string</xmlGUID>
        <siteID>string</siteID>
        <itemID>string</itemID>
        <itemType>string</itemType>
        <status>string</status>
        <createdDate>dateTime</createdDate>
        <lastUpdated>dateTime</lastUpdated>
        <xmlContent>string</xmlContent>
        <user1>string</user1>
        <user2>string</user2>
        <user3>double</user3>
        <user4>double</user4>
        <user5>string</user5>
        <user6>string</user6>
        <user7>dateTime</user7>
        <user8>dateTime</user8>
        <user9>short</user9>
        <user10>short</user10>
        <user11>string</user11>
      </inTemplate>
    </getNewDSLXML>
  </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>
    <getNewDSLXMLResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewDSLXMLResult>
        <errorMessage>string</errorMessage>
        <resultCode>int</resultCode>
        <xmlGUID>string</xmlGUID>
        <siteID>string</siteID>
        <itemID>string</itemID>
        <itemType>string</itemType>
        <status>string</status>
        <createdDate>dateTime</createdDate>
        <lastUpdated>dateTime</lastUpdated>
        <xmlContent>string</xmlContent>
        <user1>string</user1>
        <user2>string</user2>
        <user3>double</user3>
        <user4>double</user4>
        <user5>string</user5>
        <user6>string</user6>
        <user7>dateTime</user7>
        <user8>dateTime</user8>
        <user9>short</user9>
        <user10>short</user10>
        <user11>string</user11>
      </getNewDSLXMLResult>
    </getNewDSLXMLResponse>
  </soap12:Body>
</soap12:Envelope>