common Web Service

common

Click here for a complete list of operations.

editVendor

Add/Edit Vendor entries. Calls: xct_spDSLEditVendor

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

<?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>
    <editVendor xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <actionType>string</actionType>
      <inItem>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Addr1>string</Addr1>
        <Addr2>string</Addr2>
        <APAcct>string</APAcct>
        <APSub>string</APSub>
        <Attn>string</Attn>
        <BkupWthld>short</BkupWthld>
        <City>string</City>
        <ClassID>string</ClassID>
        <ContTwc1099>short</ContTwc1099>
        <Country>string</Country>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Curr1099Yr>string</Curr1099Yr>
        <CuryId>string</CuryId>
        <CuryRateType>string</CuryRateType>
        <DfltBox>string</DfltBox>
        <DfltOrdFromId>string</DfltOrdFromId>
        <DfltPurchaseType>string</DfltPurchaseType>
        <DirectDeposit>string</DirectDeposit>
        <DocPublishingFlag>string</DocPublishingFlag>
        <EMailAddr>string</EMailAddr>
        <ExcludeFreight>string</ExcludeFreight>
        <ExpAcct>string</ExpAcct>
        <ExpSub>string</ExpSub>
        <Fax>string</Fax>
        <LCCode>string</LCCode>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MultiChk>short</MultiChk>
        <Name>string</Name>
        <Next1099Yr>string</Next1099Yr>
        <NoteID>int</NoteID>
        <PayDateDflt>string</PayDateDflt>
        <PerNbr>string</PerNbr>
        <Phone>string</Phone>
        <PmtMethod>string</PmtMethod>
        <PPayAcct>string</PPayAcct>
        <PPaySub>string</PPaySub>
        <RcptPctAct>string</RcptPctAct>
        <RcptPctMax>double</RcptPctMax>
        <RcptPctMin>double</RcptPctMin>
        <RecipientName2>string</RecipientName2>
        <RemitAddr1>string</RemitAddr1>
        <RemitAddr2>string</RemitAddr2>
        <RemitAttn>string</RemitAttn>
        <RemitCity>string</RemitCity>
        <RemitCountry>string</RemitCountry>
        <RemitFax>string</RemitFax>
        <RemitName>string</RemitName>
        <RemitPhone>string</RemitPhone>
        <RemitSalut>string</RemitSalut>
        <RemitState>string</RemitState>
        <RemitZip>string</RemitZip>
        <ReqBkupWthld>short</ReqBkupWthld>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <Salut>string</Salut>
        <State>string</State>
        <Status>string</Status>
        <TaxDflt>string</TaxDflt>
        <TaxId00>string</TaxId00>
        <TaxId01>string</TaxId01>
        <TaxId02>string</TaxId02>
        <TaxId03>string</TaxId03>
        <TaxLocId>string</TaxLocId>
        <TaxPost>string</TaxPost>
        <TaxRegNbr>string</TaxRegNbr>
        <Terms>string</Terms>
        <TIN>string</TIN>
        <TINNAME>string</TINNAME>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
        <Vend1099>short</Vend1099>
        <Vend1099AddrType>string</Vend1099AddrType>
        <VendId>string</VendId>
        <Zip>string</Zip>
      </inItem>
    </editVendor>
  </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>
    <editVendorResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <editVendorResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Addr1>string</Addr1>
        <Addr2>string</Addr2>
        <APAcct>string</APAcct>
        <APSub>string</APSub>
        <Attn>string</Attn>
        <BkupWthld>short</BkupWthld>
        <City>string</City>
        <ClassID>string</ClassID>
        <ContTwc1099>short</ContTwc1099>
        <Country>string</Country>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Curr1099Yr>string</Curr1099Yr>
        <CuryId>string</CuryId>
        <CuryRateType>string</CuryRateType>
        <DfltBox>string</DfltBox>
        <DfltOrdFromId>string</DfltOrdFromId>
        <DfltPurchaseType>string</DfltPurchaseType>
        <DirectDeposit>string</DirectDeposit>
        <DocPublishingFlag>string</DocPublishingFlag>
        <EMailAddr>string</EMailAddr>
        <ExcludeFreight>string</ExcludeFreight>
        <ExpAcct>string</ExpAcct>
        <ExpSub>string</ExpSub>
        <Fax>string</Fax>
        <LCCode>string</LCCode>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MultiChk>short</MultiChk>
        <Name>string</Name>
        <Next1099Yr>string</Next1099Yr>
        <NoteID>int</NoteID>
        <PayDateDflt>string</PayDateDflt>
        <PerNbr>string</PerNbr>
        <Phone>string</Phone>
        <PmtMethod>string</PmtMethod>
        <PPayAcct>string</PPayAcct>
        <PPaySub>string</PPaySub>
        <RcptPctAct>string</RcptPctAct>
        <RcptPctMax>double</RcptPctMax>
        <RcptPctMin>double</RcptPctMin>
        <RecipientName2>string</RecipientName2>
        <RemitAddr1>string</RemitAddr1>
        <RemitAddr2>string</RemitAddr2>
        <RemitAttn>string</RemitAttn>
        <RemitCity>string</RemitCity>
        <RemitCountry>string</RemitCountry>
        <RemitFax>string</RemitFax>
        <RemitName>string</RemitName>
        <RemitPhone>string</RemitPhone>
        <RemitSalut>string</RemitSalut>
        <RemitState>string</RemitState>
        <RemitZip>string</RemitZip>
        <ReqBkupWthld>short</ReqBkupWthld>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <Salut>string</Salut>
        <State>string</State>
        <Status>string</Status>
        <TaxDflt>string</TaxDflt>
        <TaxId00>string</TaxId00>
        <TaxId01>string</TaxId01>
        <TaxId02>string</TaxId02>
        <TaxId03>string</TaxId03>
        <TaxLocId>string</TaxLocId>
        <TaxPost>string</TaxPost>
        <TaxRegNbr>string</TaxRegNbr>
        <Terms>string</Terms>
        <TIN>string</TIN>
        <TINNAME>string</TINNAME>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
        <Vend1099>short</Vend1099>
        <Vend1099AddrType>string</Vend1099AddrType>
        <VendId>string</VendId>
        <Zip>string</Zip>
      </editVendorResult>
    </editVendorResponse>
  </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>
    <editVendor xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <actionType>string</actionType>
      <inItem>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Addr1>string</Addr1>
        <Addr2>string</Addr2>
        <APAcct>string</APAcct>
        <APSub>string</APSub>
        <Attn>string</Attn>
        <BkupWthld>short</BkupWthld>
        <City>string</City>
        <ClassID>string</ClassID>
        <ContTwc1099>short</ContTwc1099>
        <Country>string</Country>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Curr1099Yr>string</Curr1099Yr>
        <CuryId>string</CuryId>
        <CuryRateType>string</CuryRateType>
        <DfltBox>string</DfltBox>
        <DfltOrdFromId>string</DfltOrdFromId>
        <DfltPurchaseType>string</DfltPurchaseType>
        <DirectDeposit>string</DirectDeposit>
        <DocPublishingFlag>string</DocPublishingFlag>
        <EMailAddr>string</EMailAddr>
        <ExcludeFreight>string</ExcludeFreight>
        <ExpAcct>string</ExpAcct>
        <ExpSub>string</ExpSub>
        <Fax>string</Fax>
        <LCCode>string</LCCode>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MultiChk>short</MultiChk>
        <Name>string</Name>
        <Next1099Yr>string</Next1099Yr>
        <NoteID>int</NoteID>
        <PayDateDflt>string</PayDateDflt>
        <PerNbr>string</PerNbr>
        <Phone>string</Phone>
        <PmtMethod>string</PmtMethod>
        <PPayAcct>string</PPayAcct>
        <PPaySub>string</PPaySub>
        <RcptPctAct>string</RcptPctAct>
        <RcptPctMax>double</RcptPctMax>
        <RcptPctMin>double</RcptPctMin>
        <RecipientName2>string</RecipientName2>
        <RemitAddr1>string</RemitAddr1>
        <RemitAddr2>string</RemitAddr2>
        <RemitAttn>string</RemitAttn>
        <RemitCity>string</RemitCity>
        <RemitCountry>string</RemitCountry>
        <RemitFax>string</RemitFax>
        <RemitName>string</RemitName>
        <RemitPhone>string</RemitPhone>
        <RemitSalut>string</RemitSalut>
        <RemitState>string</RemitState>
        <RemitZip>string</RemitZip>
        <ReqBkupWthld>short</ReqBkupWthld>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <Salut>string</Salut>
        <State>string</State>
        <Status>string</Status>
        <TaxDflt>string</TaxDflt>
        <TaxId00>string</TaxId00>
        <TaxId01>string</TaxId01>
        <TaxId02>string</TaxId02>
        <TaxId03>string</TaxId03>
        <TaxLocId>string</TaxLocId>
        <TaxPost>string</TaxPost>
        <TaxRegNbr>string</TaxRegNbr>
        <Terms>string</Terms>
        <TIN>string</TIN>
        <TINNAME>string</TINNAME>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
        <Vend1099>short</Vend1099>
        <Vend1099AddrType>string</Vend1099AddrType>
        <VendId>string</VendId>
        <Zip>string</Zip>
      </inItem>
    </editVendor>
  </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>
    <editVendorResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <editVendorResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <Addr1>string</Addr1>
        <Addr2>string</Addr2>
        <APAcct>string</APAcct>
        <APSub>string</APSub>
        <Attn>string</Attn>
        <BkupWthld>short</BkupWthld>
        <City>string</City>
        <ClassID>string</ClassID>
        <ContTwc1099>short</ContTwc1099>
        <Country>string</Country>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <Curr1099Yr>string</Curr1099Yr>
        <CuryId>string</CuryId>
        <CuryRateType>string</CuryRateType>
        <DfltBox>string</DfltBox>
        <DfltOrdFromId>string</DfltOrdFromId>
        <DfltPurchaseType>string</DfltPurchaseType>
        <DirectDeposit>string</DirectDeposit>
        <DocPublishingFlag>string</DocPublishingFlag>
        <EMailAddr>string</EMailAddr>
        <ExcludeFreight>string</ExcludeFreight>
        <ExpAcct>string</ExpAcct>
        <ExpSub>string</ExpSub>
        <Fax>string</Fax>
        <LCCode>string</LCCode>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MultiChk>short</MultiChk>
        <Name>string</Name>
        <Next1099Yr>string</Next1099Yr>
        <NoteID>int</NoteID>
        <PayDateDflt>string</PayDateDflt>
        <PerNbr>string</PerNbr>
        <Phone>string</Phone>
        <PmtMethod>string</PmtMethod>
        <PPayAcct>string</PPayAcct>
        <PPaySub>string</PPaySub>
        <RcptPctAct>string</RcptPctAct>
        <RcptPctMax>double</RcptPctMax>
        <RcptPctMin>double</RcptPctMin>
        <RecipientName2>string</RecipientName2>
        <RemitAddr1>string</RemitAddr1>
        <RemitAddr2>string</RemitAddr2>
        <RemitAttn>string</RemitAttn>
        <RemitCity>string</RemitCity>
        <RemitCountry>string</RemitCountry>
        <RemitFax>string</RemitFax>
        <RemitName>string</RemitName>
        <RemitPhone>string</RemitPhone>
        <RemitSalut>string</RemitSalut>
        <RemitState>string</RemitState>
        <RemitZip>string</RemitZip>
        <ReqBkupWthld>short</ReqBkupWthld>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <Salut>string</Salut>
        <State>string</State>
        <Status>string</Status>
        <TaxDflt>string</TaxDflt>
        <TaxId00>string</TaxId00>
        <TaxId01>string</TaxId01>
        <TaxId02>string</TaxId02>
        <TaxId03>string</TaxId03>
        <TaxLocId>string</TaxLocId>
        <TaxPost>string</TaxPost>
        <TaxRegNbr>string</TaxRegNbr>
        <Terms>string</Terms>
        <TIN>string</TIN>
        <TINNAME>string</TINNAME>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
        <Vend1099>short</Vend1099>
        <Vend1099AddrType>string</Vend1099AddrType>
        <VendId>string</VendId>
        <Zip>string</Zip>
      </editVendorResult>
    </editVendorResponse>
  </soap12:Body>
</soap12:Envelope>