Approval - Get custom approval registrations

API Url

Used for loading custom approval registrations of requested type. custom = (project, absence (AA and AH), time supplement and number supplement registrations)

GET

http://localhost:16010/ProMarkREST/rest/Approval/custom-registrations

Permissions: user

Query parameters

Field	Type	Description
approvalGroup`optional`	String	Approval Group ID. If not defined all valid approval groups are taken by default.
approvalStatus`optional`	Number	Approval status to filter data (1: Untreated, 2: Approved, 3: Rejected). In not defined then untreated transactions are returned. Size range: `1-3`
expand`optional`	String	Expand specified properties (comma delimiter) with descriptions. (Not implemented yet)
fields`optional`	String	List of fields to be returned in the collection. Used for limiting amount of data.(Not implemented yet)
from`optional`	Date	Start date for loading registrations.
to`optional`	Date	End date for loading registrations.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
registrations	Object	Collection of employee approval registrations
account1`optional`	String	Formatted value for custom account1, based on "Approval web-part Proportal 2018" setup
account2`optional`	String	Formatted value for custom account2, based on "Approval web-part Proportal 2018" setup
activityDescr`optional`	String	Activity description
activityId`optional`	String	Activity id, if used
approvalStatus	Number	Approval status
avatarURI`optional`	String	URI to the employee avatar picture.
comment`optional`	String	Comment if exists
dim1Descr`optional`	String	Dimension1 description
dim1Id`optional`	String	Dimension1 value if used
dim2Descr`optional`	String	Dimension2 description
dim2Id`optional`	String	Dimension2 value if used
empId	String	Employee identifier
empName	String	Employee first name
empNo	String	Employee No
endTime`optional`	Date	End time
format`optional`	String	Account format ("HH:MM", "HH.CC", ".1", ".2" and so on)
initials	String	Employee initials.
projectDescr`optional`	String	Project description
projectId`optional`	String	Project id, if used
registrationTime	Date	Registration Date and time as ISO-8601.
regType	String	Registration Type Id
regtypeDescr	String	Registration Type description
rejectedHigherLevel`optional`	Boolean	If it is rejected at higher level?
signOffBy`optional`	String	Signof by
signOffDateTime`optional`	Date	Sign off date time
sortEmpNo	String	Employee No used for sorting
startTime`optional`	Date	Start time
timeTypeDescr`optional`	String	Time type id, if exists
timeTypeId`optional`	String	Time type id, if exists
transSeq	Number	Transaction Sequence
treatedBy`optional`	String	Approved by
treatedByFirst`optional`	String	First approver
treatedTime`optional`	Date	Approved date time
treatedTimeFirst`optional`	Date	First Approved date time
unit`optional`	Number	Accounts unit (1: hours, 2: days, 3: pieces).
value	Number	Registration 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 for rest/Approval/custom-registrations?&approvalStatus=1&approvalGroup="XXX:"

HTTP/1.1 200 OK
{
    "response": {
        "data": {
            "registrations": [
                {
                    "empNo": "4880",
                    "sortEmpNo": "!!!!!4880",
                    "initials": "EAT",
                    "empName": "Extended Approval Test",
                    "transSeq": 2271899,
                    "registrationTime": "2018-01-03",
                    "regType": "AN",
                    "regTypeDescr": "Number supplement",
                    "timeTypeId": "STB",
                    "timeTypeDescr": "STB SecondAppr",
                    "value": 116,
                    "comment": "116~\u0003",
                    "unit": 3,
                    "format": "2",
                    "empId": "831",
                    "approvalStatus": 2
                },
                {
                    "empNo": "4880",
                    "sortEmpNo": "!!!!!4880",
                    "initials": "EAT",
                    "empName": "Extended Approval Test",
                    "transSeq": 2273705,
                    "registrationTime": "2018-01-24",
                    "regType": "AN",
                    "regTypeDescr": "Number supplement",
                    "timeTypeId": "AARSLEFF",
                    "timeTypeDescr": "Aarsleff",
                    "value": 102,
                    "projectId": "AARSLEFF",
                    "projectDescr": "Aarsleff project I",
                    "activityId": "ACT1",
                    "activityDescr": "Aarsleff activity 1",
                    "comment": "test~\u0003",
                    "unit": 3,
                    "format": "2",
                    "empId": "831",
                    "approvalStatus": 2,
                },
                {
                    "empNo": "4990",
                    "sortEmpNo": "!!!!!4880",
                    "initials": "EAI",
                    "empName": "Extended Approval II Test",
                    "transSeq": 2313713,
                    "registrationTime": "2018-02-13",
                    "regType": "AB",
                    "regTypeDescr": "Absence",
                    "timeTypeId": "CFP10",
                    "timeTypeDescr": "Bank H",
                    "startTime": "1994-01-01T07:00:00.000",
                    "endTime": "1994-01-01T15:00:00.000",
                    "value": 27000,
                    "comment": "",
                    "unit": 1,
                    "format": "1",
                    "empId": "866"
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}