ProcEngWebService


Click here for a complete list of operations.

GetEmployeeAllEntitlementForYear

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 /MobileSSMWS/ProcEngWebService.asmx HTTP/1.1
Host: ta.nmwtra.org.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.tensor.com/GetEmployeeAllEntitlementForYear"

<?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>
    <GetEmployeeAllEntitlementForYear xmlns="http://www.tensor.com/">
      <token>string</token>
      <systemID>int</systemID>
      <sysDT>dateTime</sysDT>
      <employeeID>int</employeeID>
      <year>int</year>
      <includeTimed>int</includeTimed>
    </GetEmployeeAllEntitlementForYear>
  </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>
    <GetEmployeeAllEntitlementForYearResponse xmlns="http://www.tensor.com/">
      <GetEmployeeAllEntitlementForYearResult>
        <EmployeeEntitlement>
          <EmployeeID>int</EmployeeID>
          <Year>int</Year>
          <PeriodStart>dateTime</PeriodStart>
          <PeriodEnd>dateTime</PeriodEnd>
          <AbsenceCategoryID>int</AbsenceCategoryID>
          <AbsenceCategoryName>string</AbsenceCategoryName>
          <EntitlementType>Days or Hours</EntitlementType>
          <Entitlement>double</Entitlement>
          <Carryover>double</Carryover>
          <Planned>double</Planned>
          <PlannedRnd>double</PlannedRnd>
          <Taken>double</Taken>
          <TakenRnd>double</TakenRnd>
          <Pending>double</Pending>
          <Remaining>double</Remaining>
          <RemainingIncludingPending>double</RemainingIncludingPending>
          <Total>double</Total>
          <CalculationType>Days or Hours or Formula or FormulaHours or ApportionedCategory or ApportionedPayband</CalculationType>
        </EmployeeEntitlement>
        <EmployeeEntitlement>
          <EmployeeID>int</EmployeeID>
          <Year>int</Year>
          <PeriodStart>dateTime</PeriodStart>
          <PeriodEnd>dateTime</PeriodEnd>
          <AbsenceCategoryID>int</AbsenceCategoryID>
          <AbsenceCategoryName>string</AbsenceCategoryName>
          <EntitlementType>Days or Hours</EntitlementType>
          <Entitlement>double</Entitlement>
          <Carryover>double</Carryover>
          <Planned>double</Planned>
          <PlannedRnd>double</PlannedRnd>
          <Taken>double</Taken>
          <TakenRnd>double</TakenRnd>
          <Pending>double</Pending>
          <Remaining>double</Remaining>
          <RemainingIncludingPending>double</RemainingIncludingPending>
          <Total>double</Total>
          <CalculationType>Days or Hours or Formula or FormulaHours or ApportionedCategory or ApportionedPayband</CalculationType>
        </EmployeeEntitlement>
      </GetEmployeeAllEntitlementForYearResult>
    </GetEmployeeAllEntitlementForYearResponse>
  </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 /MobileSSMWS/ProcEngWebService.asmx HTTP/1.1
Host: ta.nmwtra.org.uk
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>
    <GetEmployeeAllEntitlementForYear xmlns="http://www.tensor.com/">
      <token>string</token>
      <systemID>int</systemID>
      <sysDT>dateTime</sysDT>
      <employeeID>int</employeeID>
      <year>int</year>
      <includeTimed>int</includeTimed>
    </GetEmployeeAllEntitlementForYear>
  </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>
    <GetEmployeeAllEntitlementForYearResponse xmlns="http://www.tensor.com/">
      <GetEmployeeAllEntitlementForYearResult>
        <EmployeeEntitlement>
          <EmployeeID>int</EmployeeID>
          <Year>int</Year>
          <PeriodStart>dateTime</PeriodStart>
          <PeriodEnd>dateTime</PeriodEnd>
          <AbsenceCategoryID>int</AbsenceCategoryID>
          <AbsenceCategoryName>string</AbsenceCategoryName>
          <EntitlementType>Days or Hours</EntitlementType>
          <Entitlement>double</Entitlement>
          <Carryover>double</Carryover>
          <Planned>double</Planned>
          <PlannedRnd>double</PlannedRnd>
          <Taken>double</Taken>
          <TakenRnd>double</TakenRnd>
          <Pending>double</Pending>
          <Remaining>double</Remaining>
          <RemainingIncludingPending>double</RemainingIncludingPending>
          <Total>double</Total>
          <CalculationType>Days or Hours or Formula or FormulaHours or ApportionedCategory or ApportionedPayband</CalculationType>
        </EmployeeEntitlement>
        <EmployeeEntitlement>
          <EmployeeID>int</EmployeeID>
          <Year>int</Year>
          <PeriodStart>dateTime</PeriodStart>
          <PeriodEnd>dateTime</PeriodEnd>
          <AbsenceCategoryID>int</AbsenceCategoryID>
          <AbsenceCategoryName>string</AbsenceCategoryName>
          <EntitlementType>Days or Hours</EntitlementType>
          <Entitlement>double</Entitlement>
          <Carryover>double</Carryover>
          <Planned>double</Planned>
          <PlannedRnd>double</PlannedRnd>
          <Taken>double</Taken>
          <TakenRnd>double</TakenRnd>
          <Pending>double</Pending>
          <Remaining>double</Remaining>
          <RemainingIncludingPending>double</RemainingIncludingPending>
          <Total>double</Total>
          <CalculationType>Days or Hours or Formula or FormulaHours or ApportionedCategory or ApportionedPayband</CalculationType>
        </EmployeeEntitlement>
      </GetEmployeeAllEntitlementForYearResult>
    </GetEmployeeAllEntitlementForYearResponse>
  </soap12:Body>
</soap12:Envelope>