ProRoster - Get employee information

API Url

Use it for returning the customizable employee information fields in ProSchedule.

GET
http://localhost:16010/ProMarkREST/rest/ProRoster/employee-fields

Permissions: user

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"employeeFields": [
{
"id": "primaryQual",
"description": "Primary Qualification"
},
{
"id": "qualifications",
"description": "Qualifications"
},
{
"id": "managerId",
"description": "Manager Id"
},
{
"id": "managerName",
"description": "Manager Name"
},
{
"id": "deptId",
"description": "Home Dept. ID"
},
{
"id": "deptDesc",
"description": "Home Dept. Desc."
},
{
"id": "groupId",
"description": "Home Group ID"
},
{
"id": "groupDesc",
"description": "Home Group Desc."
},
{
"id": "apprGroupId",
"description": "Approval Group ID"
},
{
"id": "apprGroupDesc",
"description": "Approval Group Desc."
},
{
"id": "categoryId",
"description": "Category ID"
},
{
"id": "categoryDesc",
"description": "Category Desc"
},
{
"id": "divisionId",
"description": "Division"
},
{
"id": "divisionDesc",
"description": "Division Desc."
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.