General - Get registration types

API Url

Get allowed registration types for an employee. The result can depend ON the employee registration METHOD or restrictions.

GET

http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/registration-types

Permissions: user

Path parameters

Field	Type	Description
empId	String	Employee identifier

Query parameters

Field	Type	Description
context`optional`	Number	1: Employee (CVE), 2: Job (CVO), 3: Special Handling (compressed dialogues). Default is 1.
date`optional`	Date	Date when you want to make the registration. Default is TODAY.
scope`optional`	Number	1: Exclude Job registrations, 2: Include ProTime-specific Job registrations, 3: Include all Job registrations (should be used only with context = 2). Default is 3.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
registrationTypes	Object[]	Collection of registration types.
description	String	The registration description.
order	Number	Order of registration. USE this to sort the collection.
type	String	The registration type.
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": {
            "registrationTypes": [
                {
                    "order": 1,
                    "type": "AB",
                    "description": "Absence"
                },
                {
                    "order": 2,
                    "type": "CI",
                    "description": "Clock-in"
                },
                {
                    "order": 3,
                    "type": "CO",
                    "description": "Clock-out"
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}