General - Get category setup

API Url

Load basic dialogue setup from the employee category for a specific employee.

GET

http://localhost:16010/ProMarkREST/rest/General/employees/{emp_id}/category-setup

Permissions: user

Path parameters

Field	Type	Description
emp_id	String	Unique employee ID.

Query parameters

Field	Type	Description
date`optional`	Date	Date for which you need to know the setup. Default is TODAY.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
categorySetup	Object[]	The setup object.
absence	Object	Setup for absence registrations.
allowPartial	Boolean	TRUE = it's allowed to enter also part-time absences.
canDeleteIfApproved	Boolean	TRUE = employee is allowed to delete absence even if it's approved.
partialType`optional`	Integer	0 = All, 1 = Only Before CI and After CO, 2 = Only Any time.
useInterval`optional`	Boolean	TRUE = enter partial absence time as interval. FALSE = enter partial absence time as duration.
project	Object	Setup for project registrations.
allowFuture	Boolean	TRUE = It's allowed to enter project registrations in the future.
useInterval	Boolean	TRUE = enter project time as interval. FALSE = enter project time as duration.
specialHandling	Number	0 = No special handling. 1 = Special compressed dialogue handling for intervals.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
    "response": {
        "data": {
            "categorySetup": {
               "absence": {
                  "allowPartial": true,
                  "partialType": 0,
                  "useInterval": false,
                  "canDeleteIfApproved": true
               },
               "project": {
                  "useInterval": true,
                  "allowFuture": false
               }
               "specialHandling": 0
            },
            "accounts": [
                {
                    "id": "2",
                    "description": "Anden",
                    "order": 3
                },
                {
                    "id": "A000",
                    "description": "Unauthorised Absence",
                    "order": 4
                },
                {
                    "id": "A-MFA",
                    "description": "All day abs with 2 reasons - MFA",
                    "order": 6
                }
            ],
            "accountGroups": [
                {
                    "id": "NT",
                    "description": "Normtime",
                    "order": 1
                },
                {
                    "id": "2",
                    "description": "2",
                    "order": 2
                },
                {
                    "id": "BH",
                    "description": "Bo Haslund",
                    "order": 5
                }
            ] 
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.