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

Returns an employee for the given SSN and CompanyID

Request Information


NameDescriptionAdditional information
The Authentication GUID provided to you by your Account Manager

Define this parameter in the request URI.

The EHX Company ID 

Define this parameter in the request URI.

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

  "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",
  "LastName": "sample string 16",
  "LocationID": 17,
  "MailAddress1": "sample string 18",
  "MailAddress2": "sample string 19",
  "MailCity": "sample string 20",
  "MailState": "sample string 21",
  "MailZip": "sample string 22",
  "MiddleName": "sample string 23",
  "PayRateOne": "sample string 24",
  "PayRateOvertimeOne": "sample string 25",
  "PayRateType": "sample string 26",
  "PhonePrimary": "sample string 27",
  "PhoneSecondary": "sample string 28",
  "RegisterLink": "sample string 29",
  "SSN": "sample string 30",
  "StartDate": "sample string 31",
  "Status": "sample string 32",
  "Supervisor": "sample string 33",
  "WorkState": "sample string 34"

application/xml, text/xml

<MainAPI.EmployeeClass xmlns:i="" xmlns="">
  <DateOfBirth>sample string 2</DateOfBirth>
  <DateOfHire>sample string 3</DateOfHire>
  <Email>sample string 4</Email>
  <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>
  <LastName>sample string 16</LastName>
  <MailAddress1>sample string 18</MailAddress1>
  <MailAddress2>sample string 19</MailAddress2>
  <MailCity>sample string 20</MailCity>
  <MailState>sample string 21</MailState>
  <MailZip>sample string 22</MailZip>
  <MiddleName>sample string 23</MiddleName>
  <PayRateOne>sample string 24</PayRateOne>
  <PayRateOvertimeOne>sample string 25</PayRateOvertimeOne>
  <PayRateType>sample string 26</PayRateType>
  <PhonePrimary>sample string 27</PhonePrimary>
  <PhoneSecondary>sample string 28</PhoneSecondary>
  <RegisterLink>sample string 29</RegisterLink>
  <SSN>sample string 30</SSN>
  <StartDate>sample string 31</StartDate>
  <Status>sample string 32</Status>
  <Supervisor>sample string 33</Supervisor>
  <WorkState>sample string 34</WorkState>