xdd Web Service

xdd

Click here for a complete list of operations.

getNewXDDEBFile

get a blank XDDEBFile 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/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/getNewXDDEBFile"

<?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>
    <getNewXDDEBFile xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AmtApprvLvl1_A_User>string</AmtApprvLvl1_A_User>
        <AmtApprvLvl1_A_PW>string</AmtApprvLvl1_A_PW>
        <AmtApprvLvl1_B_User>string</AmtApprvLvl1_B_User>
        <AmtApprvLvl1_B_PW>string</AmtApprvLvl1_B_PW>
        <AmtApprvLvl1_C_User>string</AmtApprvLvl1_C_User>
        <AmtApprvLvl1_C_PW>string</AmtApprvLvl1_C_PW>
        <AmtApprvLvl1_D_User>string</AmtApprvLvl1_D_User>
        <AmtApprvLvl1_D_PW>string</AmtApprvLvl1_D_PW>
        <AmtApprvLvl1_E_User>string</AmtApprvLvl1_E_User>
        <AmtApprvLvl1_E_PW>string</AmtApprvLvl1_E_PW>
        <AmtApprvLvl2_A_User>string</AmtApprvLvl2_A_User>
        <AmtApprvLvl2_A_PW>string</AmtApprvLvl2_A_PW>
        <AmtApprvLvl2_B_User>string</AmtApprvLvl2_B_User>
        <AmtApprvLvl2_B_PW>string</AmtApprvLvl2_B_PW>
        <AmtApprvLvl2_C_User>string</AmtApprvLvl2_C_User>
        <AmtApprvLvl2_C_PW>string</AmtApprvLvl2_C_PW>
        <AmtApprvLvl2_D_User>string</AmtApprvLvl2_D_User>
        <AmtApprvLvl2_D_PW>string</AmtApprvLvl2_D_PW>
        <AmtApprvLvl2_E_User>string</AmtApprvLvl2_E_User>
        <AmtApprvLvl2_E_PW>string</AmtApprvLvl2_E_PW>
        <AREFTInvoices>short</AREFTInvoices>
        <AREFTTotal>double</AREFTTotal>
        <Batch_PreNote>string</Batch_PreNote>
        <BatchCount>short</BatchCount>
        <BatchTotal>double</BatchTotal>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_Time>dateTime</Crtd_Time>
        <Crtd_User>string</Crtd_User>
        <EBFileNbr>string</EBFileNbr>
        <EffDate>dateTime</EffDate>
        <FileName>string</FileName>
        <FilePath>string</FilePath>
        <FileType>string</FileType>
        <FormatID>string</FormatID>
        <KeepDelete>string</KeepDelete>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_Time>dateTime</LUpd_Time>
        <LUpd_User>string</LUpd_User>
        <Module>string</Module>
        <NoteID>int</NoteID>
        <PPAP>short</PPAP>
        <PPAPVoid>short</PPAPVoid>
        <PPPR>short</PPPR>
        <PPPRVoid>short</PPPRVoid>
        <Ret_CommType>string</Ret_CommType>
        <Ret_CommUserProg>string</Ret_CommUserProg>
        <Ret_DelFile>short</Ret_DelFile>
        <Ret_GoodRecs>int</Ret_GoodRecs>
        <Ret_WrkAcct>string</Ret_WrkAcct>
        <Ret_WrkCpnyID>string</Ret_WrkCpnyID>
        <Ret_WrkSub>string</Ret_WrkSub>
        <Sequence>short</Sequence>
        <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>
        <TransmitDate>dateTime</TransmitDate>
        <UnbalancedFile>short</UnbalancedFile>
        <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>
      </inTemplate>
    </getNewXDDEBFile>
  </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>
    <getNewXDDEBFileResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewXDDEBFileResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AmtApprvLvl1_A_User>string</AmtApprvLvl1_A_User>
        <AmtApprvLvl1_A_PW>string</AmtApprvLvl1_A_PW>
        <AmtApprvLvl1_B_User>string</AmtApprvLvl1_B_User>
        <AmtApprvLvl1_B_PW>string</AmtApprvLvl1_B_PW>
        <AmtApprvLvl1_C_User>string</AmtApprvLvl1_C_User>
        <AmtApprvLvl1_C_PW>string</AmtApprvLvl1_C_PW>
        <AmtApprvLvl1_D_User>string</AmtApprvLvl1_D_User>
        <AmtApprvLvl1_D_PW>string</AmtApprvLvl1_D_PW>
        <AmtApprvLvl1_E_User>string</AmtApprvLvl1_E_User>
        <AmtApprvLvl1_E_PW>string</AmtApprvLvl1_E_PW>
        <AmtApprvLvl2_A_User>string</AmtApprvLvl2_A_User>
        <AmtApprvLvl2_A_PW>string</AmtApprvLvl2_A_PW>
        <AmtApprvLvl2_B_User>string</AmtApprvLvl2_B_User>
        <AmtApprvLvl2_B_PW>string</AmtApprvLvl2_B_PW>
        <AmtApprvLvl2_C_User>string</AmtApprvLvl2_C_User>
        <AmtApprvLvl2_C_PW>string</AmtApprvLvl2_C_PW>
        <AmtApprvLvl2_D_User>string</AmtApprvLvl2_D_User>
        <AmtApprvLvl2_D_PW>string</AmtApprvLvl2_D_PW>
        <AmtApprvLvl2_E_User>string</AmtApprvLvl2_E_User>
        <AmtApprvLvl2_E_PW>string</AmtApprvLvl2_E_PW>
        <AREFTInvoices>short</AREFTInvoices>
        <AREFTTotal>double</AREFTTotal>
        <Batch_PreNote>string</Batch_PreNote>
        <BatchCount>short</BatchCount>
        <BatchTotal>double</BatchTotal>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_Time>dateTime</Crtd_Time>
        <Crtd_User>string</Crtd_User>
        <EBFileNbr>string</EBFileNbr>
        <EffDate>dateTime</EffDate>
        <FileName>string</FileName>
        <FilePath>string</FilePath>
        <FileType>string</FileType>
        <FormatID>string</FormatID>
        <KeepDelete>string</KeepDelete>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_Time>dateTime</LUpd_Time>
        <LUpd_User>string</LUpd_User>
        <Module>string</Module>
        <NoteID>int</NoteID>
        <PPAP>short</PPAP>
        <PPAPVoid>short</PPAPVoid>
        <PPPR>short</PPPR>
        <PPPRVoid>short</PPPRVoid>
        <Ret_CommType>string</Ret_CommType>
        <Ret_CommUserProg>string</Ret_CommUserProg>
        <Ret_DelFile>short</Ret_DelFile>
        <Ret_GoodRecs>int</Ret_GoodRecs>
        <Ret_WrkAcct>string</Ret_WrkAcct>
        <Ret_WrkCpnyID>string</Ret_WrkCpnyID>
        <Ret_WrkSub>string</Ret_WrkSub>
        <Sequence>short</Sequence>
        <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>
        <TransmitDate>dateTime</TransmitDate>
        <UnbalancedFile>short</UnbalancedFile>
        <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>
      </getNewXDDEBFileResult>
    </getNewXDDEBFileResponse>
  </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>
    <getNewXDDEBFile xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AmtApprvLvl1_A_User>string</AmtApprvLvl1_A_User>
        <AmtApprvLvl1_A_PW>string</AmtApprvLvl1_A_PW>
        <AmtApprvLvl1_B_User>string</AmtApprvLvl1_B_User>
        <AmtApprvLvl1_B_PW>string</AmtApprvLvl1_B_PW>
        <AmtApprvLvl1_C_User>string</AmtApprvLvl1_C_User>
        <AmtApprvLvl1_C_PW>string</AmtApprvLvl1_C_PW>
        <AmtApprvLvl1_D_User>string</AmtApprvLvl1_D_User>
        <AmtApprvLvl1_D_PW>string</AmtApprvLvl1_D_PW>
        <AmtApprvLvl1_E_User>string</AmtApprvLvl1_E_User>
        <AmtApprvLvl1_E_PW>string</AmtApprvLvl1_E_PW>
        <AmtApprvLvl2_A_User>string</AmtApprvLvl2_A_User>
        <AmtApprvLvl2_A_PW>string</AmtApprvLvl2_A_PW>
        <AmtApprvLvl2_B_User>string</AmtApprvLvl2_B_User>
        <AmtApprvLvl2_B_PW>string</AmtApprvLvl2_B_PW>
        <AmtApprvLvl2_C_User>string</AmtApprvLvl2_C_User>
        <AmtApprvLvl2_C_PW>string</AmtApprvLvl2_C_PW>
        <AmtApprvLvl2_D_User>string</AmtApprvLvl2_D_User>
        <AmtApprvLvl2_D_PW>string</AmtApprvLvl2_D_PW>
        <AmtApprvLvl2_E_User>string</AmtApprvLvl2_E_User>
        <AmtApprvLvl2_E_PW>string</AmtApprvLvl2_E_PW>
        <AREFTInvoices>short</AREFTInvoices>
        <AREFTTotal>double</AREFTTotal>
        <Batch_PreNote>string</Batch_PreNote>
        <BatchCount>short</BatchCount>
        <BatchTotal>double</BatchTotal>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_Time>dateTime</Crtd_Time>
        <Crtd_User>string</Crtd_User>
        <EBFileNbr>string</EBFileNbr>
        <EffDate>dateTime</EffDate>
        <FileName>string</FileName>
        <FilePath>string</FilePath>
        <FileType>string</FileType>
        <FormatID>string</FormatID>
        <KeepDelete>string</KeepDelete>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_Time>dateTime</LUpd_Time>
        <LUpd_User>string</LUpd_User>
        <Module>string</Module>
        <NoteID>int</NoteID>
        <PPAP>short</PPAP>
        <PPAPVoid>short</PPAPVoid>
        <PPPR>short</PPPR>
        <PPPRVoid>short</PPPRVoid>
        <Ret_CommType>string</Ret_CommType>
        <Ret_CommUserProg>string</Ret_CommUserProg>
        <Ret_DelFile>short</Ret_DelFile>
        <Ret_GoodRecs>int</Ret_GoodRecs>
        <Ret_WrkAcct>string</Ret_WrkAcct>
        <Ret_WrkCpnyID>string</Ret_WrkCpnyID>
        <Ret_WrkSub>string</Ret_WrkSub>
        <Sequence>short</Sequence>
        <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>
        <TransmitDate>dateTime</TransmitDate>
        <UnbalancedFile>short</UnbalancedFile>
        <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>
      </inTemplate>
    </getNewXDDEBFile>
  </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>
    <getNewXDDEBFileResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewXDDEBFileResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AmtApprvLvl1_A_User>string</AmtApprvLvl1_A_User>
        <AmtApprvLvl1_A_PW>string</AmtApprvLvl1_A_PW>
        <AmtApprvLvl1_B_User>string</AmtApprvLvl1_B_User>
        <AmtApprvLvl1_B_PW>string</AmtApprvLvl1_B_PW>
        <AmtApprvLvl1_C_User>string</AmtApprvLvl1_C_User>
        <AmtApprvLvl1_C_PW>string</AmtApprvLvl1_C_PW>
        <AmtApprvLvl1_D_User>string</AmtApprvLvl1_D_User>
        <AmtApprvLvl1_D_PW>string</AmtApprvLvl1_D_PW>
        <AmtApprvLvl1_E_User>string</AmtApprvLvl1_E_User>
        <AmtApprvLvl1_E_PW>string</AmtApprvLvl1_E_PW>
        <AmtApprvLvl2_A_User>string</AmtApprvLvl2_A_User>
        <AmtApprvLvl2_A_PW>string</AmtApprvLvl2_A_PW>
        <AmtApprvLvl2_B_User>string</AmtApprvLvl2_B_User>
        <AmtApprvLvl2_B_PW>string</AmtApprvLvl2_B_PW>
        <AmtApprvLvl2_C_User>string</AmtApprvLvl2_C_User>
        <AmtApprvLvl2_C_PW>string</AmtApprvLvl2_C_PW>
        <AmtApprvLvl2_D_User>string</AmtApprvLvl2_D_User>
        <AmtApprvLvl2_D_PW>string</AmtApprvLvl2_D_PW>
        <AmtApprvLvl2_E_User>string</AmtApprvLvl2_E_User>
        <AmtApprvLvl2_E_PW>string</AmtApprvLvl2_E_PW>
        <AREFTInvoices>short</AREFTInvoices>
        <AREFTTotal>double</AREFTTotal>
        <Batch_PreNote>string</Batch_PreNote>
        <BatchCount>short</BatchCount>
        <BatchTotal>double</BatchTotal>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_Time>dateTime</Crtd_Time>
        <Crtd_User>string</Crtd_User>
        <EBFileNbr>string</EBFileNbr>
        <EffDate>dateTime</EffDate>
        <FileName>string</FileName>
        <FilePath>string</FilePath>
        <FileType>string</FileType>
        <FormatID>string</FormatID>
        <KeepDelete>string</KeepDelete>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_Time>dateTime</LUpd_Time>
        <LUpd_User>string</LUpd_User>
        <Module>string</Module>
        <NoteID>int</NoteID>
        <PPAP>short</PPAP>
        <PPAPVoid>short</PPAPVoid>
        <PPPR>short</PPPR>
        <PPPRVoid>short</PPPRVoid>
        <Ret_CommType>string</Ret_CommType>
        <Ret_CommUserProg>string</Ret_CommUserProg>
        <Ret_DelFile>short</Ret_DelFile>
        <Ret_GoodRecs>int</Ret_GoodRecs>
        <Ret_WrkAcct>string</Ret_WrkAcct>
        <Ret_WrkCpnyID>string</Ret_WrkCpnyID>
        <Ret_WrkSub>string</Ret_WrkSub>
        <Sequence>short</Sequence>
        <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>
        <TransmitDate>dateTime</TransmitDate>
        <UnbalancedFile>short</UnbalancedFile>
        <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>
      </getNewXDDEBFileResult>
    </getNewXDDEBFileResponse>
  </soap12:Body>
</soap12:Envelope>