POST api/employee

Returns a set of Employee records based on the EmployeeSearch parameter.

Request Information

URI Parameters

None.

Body Parameters

EmployeeSearch
NameDescriptionTypeAdditional information
EmployeeCode

string

None.

EmployeeTypeId

integer

None.

SocialSecurity

string

None.

DepartmentId

integer

None.

SupervisorId

integer

None.

Inactive

boolean

None.

BranchId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "EmployeeCode": "sample string 1",
  "EmployeeTypeId": 1,
  "SocialSecurity": "sample string 2",
  "DepartmentId": 1,
  "SupervisorId": 1,
  "Inactive": true,
  "BranchId": 1
}

application/xml, text/xml

Sample:
<EmployeeSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <BranchId>1</BranchId>
  <DepartmentId>1</DepartmentId>
  <EmployeeCode>sample string 1</EmployeeCode>
  <EmployeeTypeId>1</EmployeeTypeId>
  <Inactive>true</Inactive>
  <SocialSecurity>sample string 2</SocialSecurity>
  <SupervisorId>1</SupervisorId>
</EmployeeSearch>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EmployeeSearch'.

Response Information

Resource Description

Collection of Employee
NameDescriptionTypeAdditional information
EmployeeId

integer

None.

EmployeeCode

string

None.

EmployeeTypeId

integer

None.

FirstName

string

None.

LastName

string

None.

MiddleInit

string

None.

SocialSecurity

string

None.

DepartmentId

integer

None.

SupervisorId

integer

None.

UserCode

string

None.

Receive_Inventory

string

None.

Inactive

boolean

None.

BranchId

integer

None.

CategoryId

integer

None.

PayrollAccountId

integer

None.

HireDate

date

None.

TerminationDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EmployeeId": 1,
    "EmployeeCode": "sample string 2",
    "EmployeeTypeId": 1,
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "MiddleInit": "sample string 5",
    "SocialSecurity": "sample string 6",
    "DepartmentId": 1,
    "SupervisorId": 1,
    "UserCode": "sample string 7",
    "Receive_Inventory": "sample string 8",
    "Inactive": true,
    "BranchId": 1,
    "CategoryId": 1,
    "PayrollAccountId": 1,
    "HireDate": "2024-10-18T01:14:27.4108747-05:00",
    "TerminationDate": "2024-10-18T01:14:27.4118757-05:00"
  },
  {
    "EmployeeId": 1,
    "EmployeeCode": "sample string 2",
    "EmployeeTypeId": 1,
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "MiddleInit": "sample string 5",
    "SocialSecurity": "sample string 6",
    "DepartmentId": 1,
    "SupervisorId": 1,
    "UserCode": "sample string 7",
    "Receive_Inventory": "sample string 8",
    "Inactive": true,
    "BranchId": 1,
    "CategoryId": 1,
    "PayrollAccountId": 1,
    "HireDate": "2024-10-18T01:14:27.4108747-05:00",
    "TerminationDate": "2024-10-18T01:14:27.4118757-05:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEmployee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Employee>
    <BranchId>1</BranchId>
    <CategoryId>1</CategoryId>
    <DepartmentId>1</DepartmentId>
    <EmployeeCode>sample string 2</EmployeeCode>
    <EmployeeId>1</EmployeeId>
    <EmployeeTypeId>1</EmployeeTypeId>
    <FirstName>sample string 3</FirstName>
    <HireDate>2024-10-18T01:14:27.4108747-05:00</HireDate>
    <Inactive>true</Inactive>
    <LastName>sample string 4</LastName>
    <MiddleInit>sample string 5</MiddleInit>
    <PayrollAccountId>1</PayrollAccountId>
    <Receive_Inventory>sample string 8</Receive_Inventory>
    <SocialSecurity>sample string 6</SocialSecurity>
    <SupervisorId>1</SupervisorId>
    <TerminationDate>2024-10-18T01:14:27.4118757-05:00</TerminationDate>
    <UserCode>sample string 7</UserCode>
  </Employee>
  <Employee>
    <BranchId>1</BranchId>
    <CategoryId>1</CategoryId>
    <DepartmentId>1</DepartmentId>
    <EmployeeCode>sample string 2</EmployeeCode>
    <EmployeeId>1</EmployeeId>
    <EmployeeTypeId>1</EmployeeTypeId>
    <FirstName>sample string 3</FirstName>
    <HireDate>2024-10-18T01:14:27.4108747-05:00</HireDate>
    <Inactive>true</Inactive>
    <LastName>sample string 4</LastName>
    <MiddleInit>sample string 5</MiddleInit>
    <PayrollAccountId>1</PayrollAccountId>
    <Receive_Inventory>sample string 8</Receive_Inventory>
    <SocialSecurity>sample string 6</SocialSecurity>
    <SupervisorId>1</SupervisorId>
    <TerminationDate>2024-10-18T01:14:27.4118757-05:00</TerminationDate>
    <UserCode>sample string 7</UserCode>
  </Employee>
</ArrayOfEmployee>