General - Get single day profile
API Url
Use it for loading a single day profile
http://localhost:16010/ProMarkREST/rest/General/day-profiles/{id}
Permissions: user
Request headers
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Path parameters
| Field | Type | Description |
|---|---|---|
| id | Number | The day profile ID. |
Query parameters
| Field | Type | Description |
|---|---|---|
dateoptional | Date | Date of query. Used for determening the employee category for restrictions. Default is TODAY.(empId and date are only used for HoursPerDay field) |
empIdoptional | String | Employee ID. Default is the current session employee will be used. |
fieldsoptional | String | Comma delimited list of fields to get. |
Success 200
| Field | Type | Description |
|---|---|---|
| dayProfiles | Object[] | |
backColoroptional | String | Background color as HEX without #. |
| description | String | Description of the Day Profile. |
foreColoroptional | String | Foreground color as HEX without #. |
hoursPerDayoptional | Number | Day profile's hoursPerDay in seconds. |
| id | String | Day profile ID. |
| inactive | Boolean | true = day profile is inactive. |
normalTimeStartoptional | Number | Day profile's normal start time in seconds after midnight. |
normalTimeStopoptional | Number | Day profile's normal stop time in seconds after midnight. |
Success example:
HTTP/1.1 200 OK{"response":{"data":{"dayProfile":{"id": 20002,"description": "Funktionr m/overarb.","normalTimeStart": 28800,"normalTimeStop": 72000,"foreColor": "white","backColor": "red","inactive": false,"hoursPerDay": 288000}},"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. |