GET api/Employee?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&SSN={SSN}

Returns an employee for the given SSN and CompanyID

Request Information

Parameters

Name	Description	Additional information
AuthenticationGUID	The Authentication GUID provided to you by your Account Manager	Define this parameter in the request URI.
CompanyID	The EHX Company ID	Define this parameter in the request URI.
SSN	The employee's social security number in the format xxx-xx-xxxx	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "CompanyID": 1,
  "DateOfBirth": "sample string 2",
  "DateOfHire": "sample string 3",
  "Email": "sample string 4",
  "EmployeeID": 5,
  "EmployeeStatus": "sample string 6",
  "ExternalEmployeeID": "sample string 7",
  "FirstName": "sample string 8",
  "Gender": "sample string 9",
  "HomeAddress1": "sample string 10",
  "HomeAddress2": "sample string 11",
  "HomeCity": "sample string 12",
  "HomeState": "sample string 13",
  "HomeZip": "sample string 14",
  "HoursPerWeek": "sample string 15",
  "IntroSNAP_YN": "sample string 16",
  "IntroTANF_YN": "sample string 17",
  "LastName": "sample string 18",
  "LocationID": 19,
  "MailAddress1": "sample string 20",
  "MailAddress2": "sample string 21",
  "MailCity": "sample string 22",
  "MailState": "sample string 23",
  "MailZip": "sample string 24",
  "ManagerID": 25,
  "MiddleName": "sample string 26",
  "PayRateOne": "sample string 27",
  "PayRateOvertimeOne": "sample string 28",
  "PayRateType": "sample string 29",
  "PhonePrimary": "sample string 30",
  "PhoneSecondary": "sample string 31",
  "RegisterLink": "sample string 32",
  "SSN": "sample string 33",
  "StartDate": "sample string 34",
  "Status": "sample string 35",
  "Supervisor": "sample string 36",
  "WOTCSpawnReg_YN": "sample string 37",
  "WOTCVeteran_YN": "sample string 38",
  "WorkState": "sample string 39"
}

application/xml, text/xml

Sample:

<MainAPI.EmployeeClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EFAPIWeb">
  <CompanyID>1</CompanyID>
  <DateOfBirth>sample string 2</DateOfBirth>
  <DateOfHire>sample string 3</DateOfHire>
  <Email>sample string 4</Email>
  <EmployeeID>5</EmployeeID>
  <EmployeeStatus>sample string 6</EmployeeStatus>
  <ExternalEmployeeID>sample string 7</ExternalEmployeeID>
  <FirstName>sample string 8</FirstName>
  <Gender>sample string 9</Gender>
  <HomeAddress1>sample string 10</HomeAddress1>
  <HomeAddress2>sample string 11</HomeAddress2>
  <HomeCity>sample string 12</HomeCity>
  <HomeState>sample string 13</HomeState>
  <HomeZip>sample string 14</HomeZip>
  <HoursPerWeek>sample string 15</HoursPerWeek>
  <IntroSNAP_YN>sample string 16</IntroSNAP_YN>
  <IntroTANF_YN>sample string 17</IntroTANF_YN>
  <LastName>sample string 18</LastName>
  <LocationID>19</LocationID>
  <MailAddress1>sample string 20</MailAddress1>
  <MailAddress2>sample string 21</MailAddress2>
  <MailCity>sample string 22</MailCity>
  <MailState>sample string 23</MailState>
  <MailZip>sample string 24</MailZip>
  <ManagerID>25</ManagerID>
  <MiddleName>sample string 26</MiddleName>
  <PayRateOne>sample string 27</PayRateOne>
  <PayRateOvertimeOne>sample string 28</PayRateOvertimeOne>
  <PayRateType>sample string 29</PayRateType>
  <PhonePrimary>sample string 30</PhonePrimary>
  <PhoneSecondary>sample string 31</PhoneSecondary>
  <RegisterLink>sample string 32</RegisterLink>
  <SSN>sample string 33</SSN>
  <StartDate>sample string 34</StartDate>
  <Status>sample string 35</Status>
  <Supervisor>sample string 36</Supervisor>
  <WOTCSpawnReg_YN>sample string 37</WOTCSpawnReg_YN>
  <WOTCVeteran_YN>sample string 38</WOTCVeteran_YN>
  <WorkState>sample string 39</WorkState>
</MainAPI.EmployeeClass>