General - Get day profiles

API Url

Use it for loading a list of day profiles.

GET

http://localhost:16010/ProMarkREST/rest/General/day-profiles

Permissions: user

Query parameters

Field	Type	Description
date`optional`	Date	Date of query. Used for determening the employee category for restrictions. Default is TODAY.
empId`optional`	String	List of Employee ids (comma separated). Default is the current session employee will be used.
fields`optional`	String	Comma delimited list of fields to get.
includeInactive`optional`	Boolean	true = include also inactive profiles (default false).
includeMultiShift`optional`	Boolean	true = include also the value.
onlyOptionalProfile`optional`	Boolean	true = day profiles of optional profile, false = day profiles.
time`optional`	Number	Shift time.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
dayProfiles	Object[]
arrivalTimeStart	Number	Day profile's clock-in start time in seconds after midnight.
arrivalTimeStop	Number	Day profile's clock-in stop time in seconds after midnight.
backColor`optional`	String	Background color as HEX without #.
departureTimeStart	Number	Day profile's clock-out start time in seconds after midnight.
description	String	Description of the Day Profile.
foreColor`optional`	String	Foreground color as HEX without #.
hoursPerDay`optional`	Number	Day profile's hoursPerDay in seconds.
id	String	Day profile ID.
inactive	Boolean	true = day profile is inactive.
isVariable	Boolean	true = the day profile is variable.
normalTimeStart`optional`	Number	Day profile's normal start time in seconds after midnight.
normalTimeStop`optional`	Number	Day profile's normal stop time in seconds after midnight.
shift	String	Day profile shift.
shortDescription	String	Short description of the Day Profile.
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":{  
         "dayProfile":{  
            "id": 20002,
            "description": "Funktionr m/overarb.",
            "shortDescription": "short descr"
            "normalTimeStart": 28800,
            "normalTimeStop": 72000,
            "foreColor": "white",
            "backColor": "red",
            "inactive": false,
            "isVariable": false,
            "hoursPerDay": 28800,
            "shift": "DAY",
            "arrivalTimeStart": 28500,
            "arrivalTimeStop": 28860,
            "departureTimeStart": 72000,
            "departureTimeStop": 151500       
         }
      },
      "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.