api Web Service

api

Click here for a complete list of operations.

GetEmployeesByLEAandDate

Return all Employees for the specified LEA modified since a particular date.

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 /hrms/api.asmx HTTP/1.1
Host: ncpshrms.dpi.state.nc.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://hrms.dpi.state.nc.us/GetEmployeesByLEAandDate"

<?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>
    <GetEmployeesByLEAandDate xmlns="http://hrms.dpi.state.nc.us/">
      <vendorId>string</vendorId>
      <password>string</password>
      <lea>string</lea>
      <lastModified>string</lastModified>
    </GetEmployeesByLEAandDate>
  </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>
    <GetEmployeesByLEAandDateResponse xmlns="http://hrms.dpi.state.nc.us/">
      <GetEmployeesByLEAandDateResult>
        <Employee>
          <Id>int</Id>
          <LEA>string</LEA>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Email>string</Email>
          <StatusCode>string</StatusCode>
          <StatusDescription>string</StatusDescription>
          <SiteCode>string</SiteCode>
          <SiteName>string</SiteName>
          <JobTitle>string</JobTitle>
          <OriginalHireDate>dateTime</OriginalHireDate>
          <LastHireDate>dateTime</LastHireDate>
          <TerminationDate>dateTime</TerminationDate>
          <LastModified>dateTime</LastModified>
        </Employee>
        <Employee>
          <Id>int</Id>
          <LEA>string</LEA>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Email>string</Email>
          <StatusCode>string</StatusCode>
          <StatusDescription>string</StatusDescription>
          <SiteCode>string</SiteCode>
          <SiteName>string</SiteName>
          <JobTitle>string</JobTitle>
          <OriginalHireDate>dateTime</OriginalHireDate>
          <LastHireDate>dateTime</LastHireDate>
          <TerminationDate>dateTime</TerminationDate>
          <LastModified>dateTime</LastModified>
        </Employee>
      </GetEmployeesByLEAandDateResult>
    </GetEmployeesByLEAandDateResponse>
  </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 /hrms/api.asmx HTTP/1.1
Host: ncpshrms.dpi.state.nc.us
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>
    <GetEmployeesByLEAandDate xmlns="http://hrms.dpi.state.nc.us/">
      <vendorId>string</vendorId>
      <password>string</password>
      <lea>string</lea>
      <lastModified>string</lastModified>
    </GetEmployeesByLEAandDate>
  </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>
    <GetEmployeesByLEAandDateResponse xmlns="http://hrms.dpi.state.nc.us/">
      <GetEmployeesByLEAandDateResult>
        <Employee>
          <Id>int</Id>
          <LEA>string</LEA>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Email>string</Email>
          <StatusCode>string</StatusCode>
          <StatusDescription>string</StatusDescription>
          <SiteCode>string</SiteCode>
          <SiteName>string</SiteName>
          <JobTitle>string</JobTitle>
          <OriginalHireDate>dateTime</OriginalHireDate>
          <LastHireDate>dateTime</LastHireDate>
          <TerminationDate>dateTime</TerminationDate>
          <LastModified>dateTime</LastModified>
        </Employee>
        <Employee>
          <Id>int</Id>
          <LEA>string</LEA>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Email>string</Email>
          <StatusCode>string</StatusCode>
          <StatusDescription>string</StatusDescription>
          <SiteCode>string</SiteCode>
          <SiteName>string</SiteName>
          <JobTitle>string</JobTitle>
          <OriginalHireDate>dateTime</OriginalHireDate>
          <LastHireDate>dateTime</LastHireDate>
          <TerminationDate>dateTime</TerminationDate>
          <LastModified>dateTime</LastModified>
        </Employee>
      </GetEmployeesByLEAandDateResult>
    </GetEmployeesByLEAandDateResponse>
  </soap12:Body>
</soap12:Envelope>