Supplement - Get supplement registrations for multiple employees.

API Url

Used for loading supplement registrations for one or more employees

GET

http://localhost:16010/ProMarkREST/rest/Supplement/registrations

Permissions: user

Query parameters

Field	Type	Description
empId`optional`	String	Can contain 1 or more employee IDs (comma delimiter) to filter registrations on. If employee Id is not defined returns supplement registrations for all employees.
expand`optional`	String	Expand specified properties (comma delimiter) with descriptions. Supported values are: 'all', 'supplementDescr', 'project', 'activity', 'timeType', 'piecework', 'extraInfo', 'extraInfoValue'. Supports also exclusions, so you can add a minus in front (eg. 'all,-extraInfo').
fields`optional`	String	List of fields to be returned in the collection. Used for limiting amount of data.
filter`optional`	String	Added just in case if it is required in future.
from`optional`	Date	Start date for loading registrations. Default is TODAY.
projectId`optional`	String	Can contain 1 or more project IDs (comma delimiter) to filter registrations on. If project id is not defined, check for all projects used by registrations.
readOnly`optional`	Boolean	true = Load registrations in read-only mode (better performance). Default is false.
to`optional`	Date	End date for loading registrations. Default is 'from'.
type`optional`	Number	supplement type: 0 = Time supplement, 1 = Number supplement, ? = Both

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
registrations	Object	Collection of supplement registrations.
activity`optional`	String	Activity ID. If 'expand=activity' then it's the object containing id & description.
description`optional`	String	Activity description. Only if 'expand=activity'.
id`optional`	String	Activity Id. Only if 'expand=activity'.
empId	String	Employee ID.
extraInfo`optional`	Object	Collection of extra info (project dimensions).
dimension	Number	Dimension number. If 0, then record is not a reportin dimension.
info	String	Extra info ID. If 'expand=extraInfo' then it's the object containing id & description.
description`optional`	String	Extra info description. Only if 'expand=extraInfo'.
id`optional`	String	Extra info Id. Only if 'expand=extraInfo'.
isFixedValue	Boolean	true = Answer needs to be selected from a fixed list.
value	String	Extra info value ID. If 'expand=extraInfoValue' then it's the object containing id & description.
description`optional`	String	Extra info value description. Only if 'expand=extraInfoValue'.
id`optional`	String	Extra info value Id. Only if 'expand=extraInfoValue'.
isLocked	Boolean	true = Registrations, including notes, cannot be changed.
piecework`optional`	String	Piecework ID. If 'expand=piecework' then it's the object containing id & description.
description`optional`	String	Piecework description. Only if 'expand=piecework'.
id`optional`	String	Piecework Id. Only if 'expand=piecework'.
project`optional`	String	Project ID. If 'expand=project' then it's the object containing id & description.
description`optional`	String	Project description. Only if 'expand=project'.
id`optional`	String	Project Id. Only if 'expand=project'.
supplement`optional`	String	If 'expand=supplement' then it's the object containing supplement information.
dataType`optional`	String	Supplement data type. Only if 'expand=supplement'.
description`optional`	String	Supplement description. Only if 'expand=supplement'.
format`optional`	String	Supplement fromat string. Only if 'expand=supplement'. Account format ("HH:MM", "HH.CC", ".1", ".2" and so on).
id`optional`	String	Supplement id. Only if 'expand=supplement'.
type`optional`	String	Supplement type. Only if 'expand=supplement'.
unit`optional`	String	Supplement unit. Only if 'expand=supplement'.
unitStr`optional`	String	Supplement unit string. Only if 'expand=supplement'.
supplementId`optional`	String	Supplement ID. Only if 'expand=supplement' is not defined.
supplementType`optional`	String	Supplement type 0 = Time supplement, 1 = Number supplement. Only if 'expand=supplement' is not defined.
timeType`optional`	String	Time type ID. If 'expand=timeType' then it's the object containing id & description.
description`optional`	String	Time type description. Only if 'expand=timeType'.
id`optional`	String	Time type Id. Only if 'expand=timeType'.
values	Object	Collection with registration returned back from the server.
approvalDept	String	Department secondary to approval group.
approvalGroup	String	The approval group the registration belongs to.
approvalStatus	Number	Approval status of the registration (0: No approval needed, 4: Pending approval, 5: Rejected, 2: Approved).
approvalTime	Date	Date-time when registration was approved/rejected.
approvedBy	String	The user who approved the registration.
attendanceDate	Date	Date when registration is inserted.
displayValue	String	Display value.
noLongerValid	Boolean	true = Registration is no longer valid. This could be due to change in project profiles, change of home depart back in time etc. Record cannot be changed, but it can be deleted, that is set the RegTime to zero.
note	String	Supplement note.
readOnly	Boolean	true = Registration is read only.
transSeq	Number	This is the unique transaction number. It will be filled by the server for new transactions.
value	Number	Registerered value.
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 with expand=all,-extrainfo,-extrainfoValue:

HTTP/1.1 200 OK
{
    "response": {
        "data": {
            "registrations": [
                {
                    "empId": "612",
                    "isLocked": false,
                    "extraInfo": [
                        {
                            "info": "DEPT:",
                            "value": "BAYPROJ",
                            "isFixedValue": true,
                            "dimension": 0
                        }
                    ],
                    "values": [
                        {
                            "attendanceDate": "2017-08-02",
                            "value": 14400,
                            "displayValue": "14400",
                            "readOnly": false,
                            "note": "Time suppl. test by STB",
                            "noLongerValid": true,
                            "transSeq": 2189411,
                            "approvalStatus": 0
                        }
                    ],
                    "supplement": [
                     {
                         "type": 0,
                         "id": "BH",
                         "description": "Time supplement BH",
                         "dataType": 7,
                         "unit": 1,
                         "unitStr": "Hours"
                     }
                     ],
                    "project": [
                        {
                            "id": "STB",
                            "description": "STB"
                        }
                    ],
                    "activity": [
                        {
                            "id": "10",
                            "description": "Customer visit"
                        }
                    ],
                    "timeType": [
                        {
                            "id": "NORM",
                            "description": "Normal time"
                        }
                    ]
                },
                 "errorCode": 0,
                 "errorMessage": ""
             }
         }