Get Employee Dimensions
post
/bi/v1/{orgIdentifier}/getEmployeeDimensions
Get the Employee Dimensions for a specified location.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type:
objectRequest payload with location reference
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
include:
string
Title:
IncludeList of objects to include in response -
locRef(required):
string
Title:
Location ReferenceThe location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaSearch criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : employeeDimensions
Type:
objectThe response body contains employee information about a specified location.
Show Source
-
employees(required):
array employees
An array of employees for a given location
-
locRef(required):
string
The location reference, this may be a store number or name depending on the organization
Nested Schema : employees
Type:
arrayAn array of employees for a given location
Show Source
-
Array of:
object employee
The response body contains employee information about a specified location.
Nested Schema : employee
Type:
objectThe response body contains employee information about a specified location.
Show Source
-
classMstrName:
string
Title:
Employee Class Master NameMaximum Length:99Default Employee Class Master Name. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
-
classMstrNum:
integer
Title:
Employee Class Master NumberMaximum Length:16Default Employee Class Master Number. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
-
className:
string
Title:
Employee Class NameMaximum Length:99Default employee class name assigned to the employee. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
-
classNum:
integer
Title:
Employee Class NumberMaximum Length:16Default Employee Class Number. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
-
employeeId(required):
integer
Title:
Employee IDMaximum Length:16Unique identifier of the employee -
externalPayrollID:
integer
Title:
External Payroll IDMaximum Length:16External payroll id for the employee.First Available Version: 20.1.10
-
fName(required):
string
Title:
Employee First NameMaximum Length:99The first name of the employee -
homeLocRef(required):
string
Title:
Employee Home Location ReferenceMaximum Length:99The employee's home location reference -
lName(required):
string
Title:
Employee Last NameMaximum Length:99The last name of the employee -
num(required):
integer
Title:
Employee NumberMaximum Length:16The identification number of the employee -
payrollId(required):
integer
Title:
Employee Payroll IDMaximum Length:16The employee's payroll identifier -
uuid(required):
integer
Title:
UUIDMaximum Length:16Unique identifier for employee for data privacy. This attribute will not be returned in the response if value is null
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to view all the Employee Dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getEmployeeDimensions
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"locRef:"1234",
"employees":[{
"num": 1372,
"uuId": 145326,
"employeeId": 145326,
"fName": "Adam",
"lName": "Smith",
"externalPayrollID": 145326,
"payrollId": 2327895,
"homeLocRef": "1234"
"className": "Shift Manager",
"classNum": 123,
"classMstrName": "Shift Manager",
"classMstrNum": 123
}]
}
The following example shows how to view all the Employee Dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getEmployeeDimensions
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"locRef:"1234",
"employees":[{
"num": 1372,
"uuId": 145326,
"employeeId": 145326,
"fName": "Adam",
"lName": "Smith",
"externalPayrollID": 145326,
"payrollId": 2327895,
"homeLocRef": "1234"
"className": "Shift Manager",
"classNum": 123,
"classMstrName": "Shift Manager",
"classMstrNum": 123
}]
}