employeeMaintenance Web Service

employeeMaintenance

Click here for a complete list of operations.

getBenEmpByExactID

Searches for a single BenEmp entry by ID

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/employeeMaintenance.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/getBenEmpByExactID"

<?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>
    <getBenEmpByExactID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <empID>string</empID>
      <benID>string</benID>
    </getBenEmpByExactID>
  </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>
    <getBenEmpByExactIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getBenEmpByExactIDResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <BenId>string</BenId>
        <BTotWorked>double</BTotWorked>
        <BYBegBal>double</BYBegBal>
        <BYTDAccr>double</BYTDAccr>
        <BYTDAvail>double</BYTDAvail>
        <BYTDUsed>double</BYTDUsed>
        <BYTDWorked>double</BYTDWorked>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CurrAvail>double</CurrAvail>
        <CurrBYBegBal>double</CurrBYBegBal>
        <CurrBYTDAccr>double</CurrBYTDAccr>
        <CurrBYTDAvail>double</CurrBYTDAvail>
        <CurrBYTDUsed>double</CurrBYTDUsed>
        <CurrBYTDWorked>double</CurrBYTDWorked>
        <CurrLastAvailDate>dateTime</CurrLastAvailDate>
        <CurrLastCloseDate>dateTime</CurrLastCloseDate>
        <CurrLastPayPEndDate>dateTime</CurrLastPayPEndDate>
        <CurrUsed>double</CurrUsed>
        <CurrWorked>double</CurrWorked>
        <EmpId>string</EmpId>
        <LastAccrRate>double</LastAccrRate>
        <LastAvailDate>dateTime</LastAvailDate>
        <LastCloseDate>dateTime</LastCloseDate>
        <LastPayPerEndDate>dateTime</LastPayPerEndDate>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MaxCarryOver>double</MaxCarryOver>
        <NoteId>int</NoteId>
        <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>
        <Status>string</Status>
        <TrnsBenId>string</TrnsBenId>
        <TrnsCarryFwdHist>short</TrnsCarryFwdHist>
        <TrnsDate>dateTime</TrnsDate>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </getBenEmpByExactIDResult>
    </getBenEmpByExactIDResponse>
  </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/employeeMaintenance.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>
    <getBenEmpByExactID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <empID>string</empID>
      <benID>string</benID>
    </getBenEmpByExactID>
  </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>
    <getBenEmpByExactIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getBenEmpByExactIDResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <BenId>string</BenId>
        <BTotWorked>double</BTotWorked>
        <BYBegBal>double</BYBegBal>
        <BYTDAccr>double</BYTDAccr>
        <BYTDAvail>double</BYTDAvail>
        <BYTDUsed>double</BYTDUsed>
        <BYTDWorked>double</BYTDWorked>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CurrAvail>double</CurrAvail>
        <CurrBYBegBal>double</CurrBYBegBal>
        <CurrBYTDAccr>double</CurrBYTDAccr>
        <CurrBYTDAvail>double</CurrBYTDAvail>
        <CurrBYTDUsed>double</CurrBYTDUsed>
        <CurrBYTDWorked>double</CurrBYTDWorked>
        <CurrLastAvailDate>dateTime</CurrLastAvailDate>
        <CurrLastCloseDate>dateTime</CurrLastCloseDate>
        <CurrLastPayPEndDate>dateTime</CurrLastPayPEndDate>
        <CurrUsed>double</CurrUsed>
        <CurrWorked>double</CurrWorked>
        <EmpId>string</EmpId>
        <LastAccrRate>double</LastAccrRate>
        <LastAvailDate>dateTime</LastAvailDate>
        <LastCloseDate>dateTime</LastCloseDate>
        <LastPayPerEndDate>dateTime</LastPayPerEndDate>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MaxCarryOver>double</MaxCarryOver>
        <NoteId>int</NoteId>
        <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>
        <Status>string</Status>
        <TrnsBenId>string</TrnsBenId>
        <TrnsCarryFwdHist>short</TrnsCarryFwdHist>
        <TrnsDate>dateTime</TrnsDate>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </getBenEmpByExactIDResult>
    </getBenEmpByExactIDResponse>
  </soap12:Body>
</soap12:Envelope>