xdd Web Service

xdd

Click here for a complete list of operations.

editXDDSetUpExAsDataSet

Add/Edit XDDSetUpEx entries. Calls: xct_spDSLXDDEditXDDSetUpEx

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/xdd.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/editXDDSetUpExAsDataSet"

<?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>
    <editXDDSetUpExAsDataSet xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <actionType>string</actionType>
      <inItem>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AcctApp>short</AcctApp>
        <ACHOrigDFI>string</ACHOrigDFI>
        <ACHOrigDFIName>string</ACHOrigDFIName>
        <APAmtAppLvl1Amt>double</APAmtAppLvl1Amt>
        <APAmtAppLvl1NbrA>short</APAmtAppLvl1NbrA>
        <APAmtAppLvl2Amt>double</APAmtAppLvl2Amt>
        <APAmtAppLvl2NbrA>short</APAmtAppLvl2NbrA>
        <APAmtAppUserSetsApp>string</APAmtAppUserSetsApp>
        <APAPO>short</APAPO>
        <APAPOComm>short</APAPOComm>
        <APAPOFileNbrg>short</APAPOFileNbrg>
        <APAPONextFileNbr>string</APAPONextFileNbr>
        <APAPOPreNotesOne>short</APAPOPreNotesOne>
        <APEFTNoOrphanChk>short</APEFTNoOrphanChk>
        <APEFTPrintAudit>short</APEFTPrintAudit>
        <APEFTPrintAuditChg>short</APEFTPrintAuditChg>
        <APEMAttachByA>short</APEMAttachByA>
        <APEMAttachByV>short</APEMAttachByV>
        <APEMAttachFExt>string</APEMAttachFExt>
        <APEMAttachFF>string</APEMAttachFF>
        <APEMAttachFN>string</APEMAttachFN>
        <APEMAttachFND>short</APEMAttachFND>
        <APEMAttachFNI>short</APEMAttachFNI>
        <APEMAttachFNote>string</APEMAttachFNote>
        <APEMAttachFRL>short</APEMAttachFRL>
        <APEMAttachInclBMsg>short</APEMAttachInclBMsg>
        <APEMAttachInclTMsg>short</APEMAttachInclTMsg>
        <APEMAttachNbrDocs>short</APEMAttachNbrDocs>
        <APEMAttachSP>string</APEMAttachSP>
        <APEMAttachUse>short</APEMAttachUse>
        <APFileHideCompBatch>short</APFileHideCompBatch>
        <APFileNameAddDate>short</APFileNameAddDate>
        <APFileNameAddEBNbr>short</APFileNameAddEBNbr>
        <APFileNameCanChange>short</APFileNameCanChange>
        <APFileNameConnector>string</APFileNameConnector>
        <APFilePeriodsRet>short</APFilePeriodsRet>
        <APGatewayOperID>string</APGatewayOperID>
        <APShowPosted>short</APShowPosted>
        <AREFTNoOrphanChk>short</AREFTNoOrphanChk>
        <AREFTPrintAudit>short</AREFTPrintAudit>
        <AREFTPrintAuditChg>short</AREFTPrintAuditChg>
        <AREMAttachByA>short</AREMAttachByA>
        <AREMAttachByC>short</AREMAttachByC>
        <AREMAttachFExt>string</AREMAttachFExt>
        <AREMAttachFF>string</AREMAttachFF>
        <AREMAttachFN>string</AREMAttachFN>
        <AREMAttachFND>short</AREMAttachFND>
        <AREMAttachFNI>short</AREMAttachFNI>
        <AREMAttachFNote>string</AREMAttachFNote>
        <AREMAttachFRL>short</AREMAttachFRL>
        <AREMAttachInclBMsg>short</AREMAttachInclBMsg>
        <AREMAttachInclTMsg>short</AREMAttachInclTMsg>
        <AREMAttachNbrDocs>short</AREMAttachNbrDocs>
        <AREMAttachSP>string</AREMAttachSP>
        <AREMAttachUse>short</AREMAttachUse>
        <ARFileHideCompBatch>short</ARFileHideCompBatch>
        <ARFileNameAddDate>short</ARFileNameAddDate>
        <ARFileNameAddEBNbr>short</ARFileNameAddEBNbr>
        <ARFileNameCanChange>short</ARFileNameCanChange>
        <ARFileNameConnector>string</ARFileNameConnector>
        <ARFilePeriodsRet>short</ARFilePeriodsRet>
        <ARNextFileNbr>string</ARNextFileNbr>
        <ARShowPosted>short</ARShowPosted>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <EMASBurstDelay>short</EMASBurstDelay>
        <EMASEmailsInBurst>short</EMASEmailsInBurst>
        <LBAddMissingCM>short</LBAddMissingCM>
        <LBAlwaysApplyDisc>short</LBAlwaysApplyDisc>
        <LBErrorShowChgdPmt>short</LBErrorShowChgdPmt>
        <LBFilePeriodsRet>short</LBFilePeriodsRet>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MultiVendAcct>string</MultiVendAcct>
        <MultiVendAcctUse>short</MultiVendAcctUse>
        <NoteID>int</NoteID>
        <PPFileHideCompBatch>short</PPFileHideCompBatch>
        <PPFileNameAddDate>short</PPFileNameAddDate>
        <PPFileNameAddEBNbr>short</PPFileNameAddEBNbr>
        <PPFileNameCanChange>short</PPFileNameCanChange>
        <PPFileNameConnector>string</PPFileNameConnector>
        <PPFilePeriodsRet>short</PPFilePeriodsRet>
        <PPNextFileNbr>string</PPNextFileNbr>
        <PPShowPosted>short</PPShowPosted>
        <SecurityMsgOff>short</SecurityMsgOff>
        <SetUpID>string</SetUpID>
        <SKFuture01>string</SKFuture01>
        <SKFuture02>string</SKFuture02>
        <SKFuture03>double</SKFuture03>
        <SKFuture04>double</SKFuture04>
        <SKFuture05>double</SKFuture05>
        <SKFuture06>double</SKFuture06>
        <SKFuture07>dateTime</SKFuture07>
        <SKFuture08>dateTime</SKFuture08>
        <SKFuture09>int</SKFuture09>
        <SKFuture10>int</SKFuture10>
        <SKFuture11>string</SKFuture11>
        <SKFuture12>string</SKFuture12>
        <User1>string</User1>
        <User10>string</User10>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
        <User9>string</User9>
        <WTDefaultOrdParty>short</WTDefaultOrdParty>
        <WTFileNameAddDate>short</WTFileNameAddDate>
        <WTFileNameAddEBNbr>short</WTFileNameAddEBNbr>
        <WTFileNameConnector>string</WTFileNameConnector>
      </inItem>
    </editXDDSetUpExAsDataSet>
  </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>
    <editXDDSetUpExAsDataSetResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <editXDDSetUpExAsDataSetResult>
        <xsd:schema>schema</xsd:schema>xml</editXDDSetUpExAsDataSetResult>
    </editXDDSetUpExAsDataSetResponse>
  </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/xdd.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>
    <editXDDSetUpExAsDataSet xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <actionType>string</actionType>
      <inItem>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AcctApp>short</AcctApp>
        <ACHOrigDFI>string</ACHOrigDFI>
        <ACHOrigDFIName>string</ACHOrigDFIName>
        <APAmtAppLvl1Amt>double</APAmtAppLvl1Amt>
        <APAmtAppLvl1NbrA>short</APAmtAppLvl1NbrA>
        <APAmtAppLvl2Amt>double</APAmtAppLvl2Amt>
        <APAmtAppLvl2NbrA>short</APAmtAppLvl2NbrA>
        <APAmtAppUserSetsApp>string</APAmtAppUserSetsApp>
        <APAPO>short</APAPO>
        <APAPOComm>short</APAPOComm>
        <APAPOFileNbrg>short</APAPOFileNbrg>
        <APAPONextFileNbr>string</APAPONextFileNbr>
        <APAPOPreNotesOne>short</APAPOPreNotesOne>
        <APEFTNoOrphanChk>short</APEFTNoOrphanChk>
        <APEFTPrintAudit>short</APEFTPrintAudit>
        <APEFTPrintAuditChg>short</APEFTPrintAuditChg>
        <APEMAttachByA>short</APEMAttachByA>
        <APEMAttachByV>short</APEMAttachByV>
        <APEMAttachFExt>string</APEMAttachFExt>
        <APEMAttachFF>string</APEMAttachFF>
        <APEMAttachFN>string</APEMAttachFN>
        <APEMAttachFND>short</APEMAttachFND>
        <APEMAttachFNI>short</APEMAttachFNI>
        <APEMAttachFNote>string</APEMAttachFNote>
        <APEMAttachFRL>short</APEMAttachFRL>
        <APEMAttachInclBMsg>short</APEMAttachInclBMsg>
        <APEMAttachInclTMsg>short</APEMAttachInclTMsg>
        <APEMAttachNbrDocs>short</APEMAttachNbrDocs>
        <APEMAttachSP>string</APEMAttachSP>
        <APEMAttachUse>short</APEMAttachUse>
        <APFileHideCompBatch>short</APFileHideCompBatch>
        <APFileNameAddDate>short</APFileNameAddDate>
        <APFileNameAddEBNbr>short</APFileNameAddEBNbr>
        <APFileNameCanChange>short</APFileNameCanChange>
        <APFileNameConnector>string</APFileNameConnector>
        <APFilePeriodsRet>short</APFilePeriodsRet>
        <APGatewayOperID>string</APGatewayOperID>
        <APShowPosted>short</APShowPosted>
        <AREFTNoOrphanChk>short</AREFTNoOrphanChk>
        <AREFTPrintAudit>short</AREFTPrintAudit>
        <AREFTPrintAuditChg>short</AREFTPrintAuditChg>
        <AREMAttachByA>short</AREMAttachByA>
        <AREMAttachByC>short</AREMAttachByC>
        <AREMAttachFExt>string</AREMAttachFExt>
        <AREMAttachFF>string</AREMAttachFF>
        <AREMAttachFN>string</AREMAttachFN>
        <AREMAttachFND>short</AREMAttachFND>
        <AREMAttachFNI>short</AREMAttachFNI>
        <AREMAttachFNote>string</AREMAttachFNote>
        <AREMAttachFRL>short</AREMAttachFRL>
        <AREMAttachInclBMsg>short</AREMAttachInclBMsg>
        <AREMAttachInclTMsg>short</AREMAttachInclTMsg>
        <AREMAttachNbrDocs>short</AREMAttachNbrDocs>
        <AREMAttachSP>string</AREMAttachSP>
        <AREMAttachUse>short</AREMAttachUse>
        <ARFileHideCompBatch>short</ARFileHideCompBatch>
        <ARFileNameAddDate>short</ARFileNameAddDate>
        <ARFileNameAddEBNbr>short</ARFileNameAddEBNbr>
        <ARFileNameCanChange>short</ARFileNameCanChange>
        <ARFileNameConnector>string</ARFileNameConnector>
        <ARFilePeriodsRet>short</ARFilePeriodsRet>
        <ARNextFileNbr>string</ARNextFileNbr>
        <ARShowPosted>short</ARShowPosted>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <EMASBurstDelay>short</EMASBurstDelay>
        <EMASEmailsInBurst>short</EMASEmailsInBurst>
        <LBAddMissingCM>short</LBAddMissingCM>
        <LBAlwaysApplyDisc>short</LBAlwaysApplyDisc>
        <LBErrorShowChgdPmt>short</LBErrorShowChgdPmt>
        <LBFilePeriodsRet>short</LBFilePeriodsRet>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MultiVendAcct>string</MultiVendAcct>
        <MultiVendAcctUse>short</MultiVendAcctUse>
        <NoteID>int</NoteID>
        <PPFileHideCompBatch>short</PPFileHideCompBatch>
        <PPFileNameAddDate>short</PPFileNameAddDate>
        <PPFileNameAddEBNbr>short</PPFileNameAddEBNbr>
        <PPFileNameCanChange>short</PPFileNameCanChange>
        <PPFileNameConnector>string</PPFileNameConnector>
        <PPFilePeriodsRet>short</PPFilePeriodsRet>
        <PPNextFileNbr>string</PPNextFileNbr>
        <PPShowPosted>short</PPShowPosted>
        <SecurityMsgOff>short</SecurityMsgOff>
        <SetUpID>string</SetUpID>
        <SKFuture01>string</SKFuture01>
        <SKFuture02>string</SKFuture02>
        <SKFuture03>double</SKFuture03>
        <SKFuture04>double</SKFuture04>
        <SKFuture05>double</SKFuture05>
        <SKFuture06>double</SKFuture06>
        <SKFuture07>dateTime</SKFuture07>
        <SKFuture08>dateTime</SKFuture08>
        <SKFuture09>int</SKFuture09>
        <SKFuture10>int</SKFuture10>
        <SKFuture11>string</SKFuture11>
        <SKFuture12>string</SKFuture12>
        <User1>string</User1>
        <User10>string</User10>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
        <User9>string</User9>
        <WTDefaultOrdParty>short</WTDefaultOrdParty>
        <WTFileNameAddDate>short</WTFileNameAddDate>
        <WTFileNameAddEBNbr>short</WTFileNameAddEBNbr>
        <WTFileNameConnector>string</WTFileNameConnector>
      </inItem>
    </editXDDSetUpExAsDataSet>
  </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>
    <editXDDSetUpExAsDataSetResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <editXDDSetUpExAsDataSetResult>
        <xsd:schema>schema</xsd:schema>xml</editXDDSetUpExAsDataSetResult>
    </editXDDSetUpExAsDataSetResponse>
  </soap12:Body>
</soap12:Envelope>