POST v1/employee-navigator/companies/{companyCode}/employees/{employeeKey}

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required
employeeKey		globally unique identifier	Required

Body Parameters

EmployeeNavigatorEmployeeDTO

Name	Type	Additional information
CompanyId	string	None.
EmployeeIdentifier	string	None.
SSN	string	None.
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
DOB	FixedDateTime	None.
HireDate	FixedDateTime	None.
TerminationDate	FixedDateTime	None.
PayEffectiveDate	FixedDateTime	None.
CompensationBasis	string	None.
AnnualBaseSalary	decimal number	None.
BaseHourlyRate	decimal number	None.
Address1	string	None.
Address2	string	None.
City	string	None.
State	string	None.
ZIP	string	None.
Email	string	None.
Phone	string	None.

Request Formats

application/json, text/json

Sample:

{
  "companyId": "sample string 1",
  "employeeIdentifier": "sample string 2",
  "ssn": "sample string 3",
  "firstName": "sample string 4",
  "middleName": "sample string 5",
  "lastName": "sample string 6",
  "dob": "0001-02-03T09:05:06.007Z",
  "hireDate": "0001-02-03T09:05:06.007Z",
  "terminationDate": "0001-02-03T09:05:06.007Z",
  "payEffectiveDate": "0001-02-03T09:05:06.007Z",
  "compensationBasis": "sample string 7",
  "annualBaseSalary": 1.0,
  "baseHourlyRate": 1.0,
  "address1": "sample string 8",
  "address2": "sample string 9",
  "city": "sample string 10",
  "state": "sample string 11",
  "zip": "sample string 12",
  "email": "sample string 13",
  "phone": "sample string 14"
}

text/xml

Sample:

<EmployeeNavigatorEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.EmployeeNavigator.ServiceContracts.Data.Models">
  <Address1>sample string 8</Address1>
  <Address2>sample string 9</Address2>
  <AnnualBaseSalary>1</AnnualBaseSalary>
  <BaseHourlyRate>1</BaseHourlyRate>
  <City>sample string 10</City>
  <CompanyId>sample string 1</CompanyId>
  <CompensationBasis>sample string 7</CompensationBasis>
  <DOB xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
    <d2p1:Hour>4</d2p1:Hour>
    <d2p1:Minute>5</d2p1:Minute>
    <d2p1:Second>6</d2p1:Second>
    <d2p1:Milisecond>7</d2p1:Milisecond>
  </DOB>
  <Email>sample string 13</Email>
  <EmployeeIdentifier>sample string 2</EmployeeIdentifier>
  <FirstName>sample string 4</FirstName>
  <HireDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
    <d2p1:Hour>4</d2p1:Hour>
    <d2p1:Minute>5</d2p1:Minute>
    <d2p1:Second>6</d2p1:Second>
    <d2p1:Milisecond>7</d2p1:Milisecond>
  </HireDate>
  <LastName>sample string 6</LastName>
  <MiddleName>sample string 5</MiddleName>
  <PayEffectiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
    <d2p1:Hour>4</d2p1:Hour>
    <d2p1:Minute>5</d2p1:Minute>
    <d2p1:Second>6</d2p1:Second>
    <d2p1:Milisecond>7</d2p1:Milisecond>
  </PayEffectiveDate>
  <Phone>sample string 14</Phone>
  <SSN>sample string 3</SSN>
  <State>sample string 11</State>
  <TerminationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
    <d2p1:Hour>4</d2p1:Hour>
    <d2p1:Minute>5</d2p1:Minute>
    <d2p1:Second>6</d2p1:Second>
    <d2p1:Milisecond>7</d2p1:Milisecond>
  </TerminationDate>
  <ZIP>sample string 12</ZIP>
</EmployeeNavigatorEmployeeDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmployeeNavigatorEmployeeResponseDTO

Name	Description	Type	Additional information
Result		EmployeeNavigatorEmployeeResultDTO	None.
Messages		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "result": {
    "payrollId": "sample string 1"
  },
  "messages": [
    "sample string 1",
    "sample string 2"
  ]
}

text/xml

Sample:

<EmployeeNavigatorEmployeeResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.EmployeeNavigator.ServiceContracts.Data.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <Result>
    <PayrollId>sample string 1</PayrollId>
  </Result>
</EmployeeNavigatorEmployeeResponseDTO>