Delete Employee Positions
- 1 Minute to read
- Print
- DarkLight
- PDF
Delete Employee Positions
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
We have introduced an API that allows you to delete employee positions to eliminate duplicate employee positions or inactive positions. You can delete single or multiple employee positions. When you delete employee positions, the audit log gets updated. You can use the following fields to filter the output:
• By Scenario
• By Home Budget Entity
• By Employee
• By Employee and Position Description
Method
POST
Endpoint Url Syntax
Content Type
application/json
Headers
Key | Value |
---|---|
APIKey | Key |
Example1
Request
{
"EmployeeFilterOptions": "EmployeePositions",
"ScenarioCode": "Workforce-FY21",
"EmployeeData" :
[
["HYD004","P1","SDE"],
["HYD003","P1","P2"]
]
}
Reponse
{
"Status": "Failure",
“ScenarioCode": "Workforce-FY21"
"DeleteEmployeesResult": [
{
"Key": "HYD004",
"Values": [
"Employee Number HYD004 is invalid."
]
},
{
"Key": "HYD003",
"Values": [
"P1 does not exist for Employee HYD003",
"P2 does not exist for Employee HYD003"
]
}
]
}
Example2
**Request
**
{
"EmployeeFilterOptions": "EmployeePositions",
"ScenarioCode": "Workforce-FY21",
"EmployeeData" :
[
["HYD002","SDE"],
["HYD003","SDE","P2"]
]
}
Reponse
{
"Status": "PartialSuccess",
“ScenarioCode": "Workforce-FY21"
"DeleteEmployeesResult": [
{
"Key": "HYD003",
"Values": [
"P2 does not exist for Employee HYD003",
"Employee Position SDE deleted successfully."
]
},
{
"Key": "HYD002",
"Values": [
"Employee Position SDE deleted successfully."
]
}
]
}
Example3
Request
{
"EmployeeFilterOptions": "Employees",
"ScenarioCode": "Workforce-FY21",
"EmployeeData" :
[
["HYD002"],
["HYD003"]
]
}
Reponse
{
"Status": "Failure",
“ScenarioCode": "Workforce-FY21"
"DeleteEmployeesResult": [
{
"Key": "HYD002",
"Values": [
"Employee Number HYD002 is invalid."
]
},
{
"Key": "HYD003",
"Values": [
"Employee Number HYD003 is invalid."
]
}
]
}
Example4
Request
{
"EmployeeFilterOptions": "Employees",
"ScenarioCode": "Workforce-FY21",
"EmployeeData" :
[
["HYD005"],
["HYD006"]
]
}
Reponse
{
"Status": "PartialSuccess",
“ScenarioCode": "Workforce-FY21"
"DeleteEmployeesResult": [
{
"Key": "HYD006",
"Values": [
"Employee Number HYD006 is invalid."
]
},
{
"Key": "HYD005",
"Values": [
"Employee deleted successfully."
]
}
]
}
Example5
**Request
**
{
"EmployeeFilterOptions": "HomeBudgetEntities",
"ScenarioCode": "Workforce-FY21",
"EmployeeData" :
[
["Hbe1"],
["Hbe2"]
]
}
Reponse
{
"Status": "Failure",
“ScenarioCode": "Workforce-FY21"
"DeleteEmployeesResult": [
{
"Key": "HomeBudgetEntities",
"Values": [
"Please provide a value for </BE>."
]
}
]
}
Example6
Request
{
"EmployeeFilterOptions": "HomeBudgetEntities",
"ScenarioCode": "Workforce-FY21",
"HomeBudgetEntityCode" :
["1000","HBE01"]
}
Reponse
{
"Status": "PartialSuccess",
“ScenarioCode": "Workforce-FY21"
"DeleteEmployeesResult": [
{
"Key": "HBE01",
"Values": [
"Home Budget entity Code HBE01 is invalid."
]
},
{
"Key": "1000",
"Values": [
"Employee(s) deleted successfully."
]
}
]
}
Was this article helpful?