common Web Service

common

Click here for a complete list of operations.

editSegDef

Add/Edit SegDef entries. Calls: xct_spDSLEditSegDef

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

<?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>
    <editSegDef xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <actionType>string</actionType>
      <inSegDef>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Active>short</Active>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Description>string</Description>
        <FieldClass>string</FieldClass>
        <FieldClassName>string</FieldClassName>
        <ID>string</ID>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <SegNumber>string</SegNumber>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
      </inSegDef>
    </editSegDef>
  </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>
    <editSegDefResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <editSegDefResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Active>short</Active>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Description>string</Description>
        <FieldClass>string</FieldClass>
        <FieldClassName>string</FieldClassName>
        <ID>string</ID>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <SegNumber>string</SegNumber>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
      </editSegDefResult>
    </editSegDefResponse>
  </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>
    <editSegDef xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <actionType>string</actionType>
      <inSegDef>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Active>short</Active>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Description>string</Description>
        <FieldClass>string</FieldClass>
        <FieldClassName>string</FieldClassName>
        <ID>string</ID>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <SegNumber>string</SegNumber>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
      </inSegDef>
    </editSegDef>
  </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>
    <editSegDefResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <editSegDefResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Active>short</Active>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Description>string</Description>
        <FieldClass>string</FieldClass>
        <FieldClassName>string</FieldClassName>
        <ID>string</ID>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <SegNumber>string</SegNumber>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
      </editSegDefResult>
    </editSegDefResponse>
  </soap12:Body>
</soap12:Envelope>