ProRoster - Get all stamps

API Url

Used for getting all stamps

GET

http://localhost:16010/ProMarkREST/web/ProRoster/stamps

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
stamps	Object[]
absenceReason`optional`	Object[]
backColor	String	The background color of the absence reason
code	String	The code of the absence reason
description	String	The description of the absence reason
foreColor	String	The foreground color of the absence reason
attendanceProfile`optional`	Object[]
desc	String	The description of the attendance profile
id	String	The attendance profile's id
sortId	String	The sort id of the attendance profile
attendanceTime`optional`	Object[]
endTime	Number	End time
isLocked	Boolean	TRUE if it is locked
isRequired	Boolean	TRUE if it is required
startTime	Number	Start time
dayProfile`optional`	Object[]
arrivalTImeStart	Number	Arrival time start
arrivalTimeStop	Number	Arrival time stop
departureTimeStart	Number	Departure time start
departureTimeStop	Number	Departure time stop
desription	String	The description of the day profile
hoursPerDay	Number	Hours per day
id	String	The day profile id
inactive	Boolean	TRUE if the day profile is inactive
isVariable	Boolean	TRUE if the day profile is variable
normalTimeStart	Number	Normal time start
normalTimeStop	Number	Normal time stop
department`optional`	Object[]
description	String	The description of the department
id	String	The department's id
sortId	String	The sort id of the department
group`optional`	Object[]
description	String	The description of the group
id	String	The group's id
sortId	String	The sort id of the group
normalTime`optional`	Object[]
endTime	Number	End time
isLocked	Boolean	TRUE if it is locked
isRequired	Boolean	TRUE if it is required
startTime	Number	Start time
type	Number	The type of the stamp. `0`: Shift `1`: All day absence `2`: Attendance profile
valueTypes	String[]	An array with the value types that will be inserted for the stamp
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:

{
    "response": {
        "data": {
            "stamps": [{
                "stampId": 2164886755,
                "type": 0,
                "valueTypes": [
                    "day-profile",
                    "normal-time",
                    "department"
                ],
                "day-profile": [
                    {
                        "id": "BAY7-16",
                        "description": "07: 00 - 16: 00, Bay test",
                        "normalTimeStart": 25200,
                        "normalTimeStop": 57600,
                        "isVariable": "false",
                        "hoursPerDay": 28800,
                        "inactive": "false",
                        "arrivalTimeStop": 86400,
                        "departureTimeStop": 86400,
                        "normalTimeIntervalFormatted": "07: 00 - 16: 00",
                        "arrivalTimeIntervalFormatted": "--:-- - 00: 00",
                        "departureTimeIntervalFormatted": "--:-- - 00: 00",
                        "hourPerDayFormatted": "08: 00"
                    }],
                    "normal-time": [
                        {
                        "startTime": 25200,
                        "endTime": 57600,
                        "isLocked": "false",
                        "isRequired": "false"
                    }],
                    "department":[{
                        "id": "17",
                        "sortId": "!!!!!!!!17",
                        "desc": "HR Department",
                        "description": "HR Department"
                    }]
            }]
        }
    }
}

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.