General - Get break intervals

API Url

Used to get break intervals for an employee.

GET

http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/break-intervals

Permissions: user

Path parameters

Field	Type	Description
empId	String	Unique employee identifier.

Query parameters

Field	Type	Description
startDate`optional`	Date	Break start date, Default:TODAY.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
breakIntervals	Object	Break intervals object
breakProfId	String	Break profile identifier
breaks	Object[]	Break interval Objects
end	Number	Break end time in integer.
start	Number	Break start time in integer.
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": {
            "breakIntervals": {
                "breakProfId": "BH",
                "breaks": [
                    {
                        "start": 36000,
                        "end": 36900                           
                    },
                    {
                        "start": 43200,
                        "end": 46800                           
                    },
                    {
                        "start": 50880,
                        "end": 51000
                    }
                ]
            }
        },
        "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.