Analysis - Get project registrations

API Url

Used for loading project registrations according to a filter setup, where it's also possible to group on specific fields.

GET

http://localhost:16010/ProMarkREST/rest/Analysis/project-registrations

Permissions: user

Query parameters

Field	Type	Description
activityId`optional`	String	Can contain 1 or more activity IDs (comma delimiter) to filter registration on.
empId`optional`	Number	Can contain 1 or more employee IDs (comma delimiter) to filter registrations on.
fields`optional`	String	List of fields to be returned in the collection. Used for limiting amount of data.
filter`optional`	String	Filter fields, values and conditions, in a json format.
from`optional`	Date	Start date for loading registrations. Default is TODAY.
groupBy`optional`	String	Group registrations by empId,projectId,activityId,timeTypeId.
projectId`optional`	String	Can contain 1 or more project IDs (comma delimiter) to filter registration on.
timeTypeId`optional`	String	Can contain 1 or more timeType IDs (comma delimiter) to filter registration on.
to`optional`	Date	End date for loading registrations. Default is 'from'.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
projectRegistrations	Object	Collection of project registrations. All registration entries from 'values' have the same parent coordinates, like employee, project, activity, time type, extra info.
activityDesc	String	Activity description.
activityId	String	Activity ID.
attendanceDate	String	Date of registration.
avatarURI`optional`	String	URI used for loading the employee avatar.
budget`optional`	Number	Registration budget.
dimensionDesc1`optional`	String	Dimension1 description.
dimensionDesc2`optional`	String	Dimension2 description.
dimensionDesc3`optional`	String	Dimension3 description.
dimensionDesc4`optional`	String	Dimension4 description.
dimensionDesc5`optional`	String	Dimension5 description.
dimensionId1`optional`	String	Dimension1 id.
dimensionId2`optional`	String	Dimension2 id.
dimensionId3`optional`	String	Dimension3 id.
dimensionId4`optional`	String	Dimension4 id.
dimensionId5`optional`	String	Dimension5 id.
empId	String	Employee ID.
empName	String	Employee Name.
empNo	String	Employee No.
initials	String	Employee initials.
plannedTime`optional`	Number	Activity planned time.
projectDesc	String	Project description.
projectId	String	Project ID.
projectRef1	String	Project Ref1.
projectRef2	String	Project Ref2.
projectRef3	String	Project Ref3.
registeredTime	Number	Registration time.
sortEmpNo	String	Sort employee No.
timeTypeDesc	String	Time type description.
timeTypeId	String	Time type ID.
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 filter=[{"type":4,"fields":[{"fieldId":"1","condition":"1","values":["4711"]}]}]:

HTTP/1.1 200 OK
   {
    "response": {
        "data": {
            "projectRegistrations": [
                {
                    "empId": "605",
                    "empName": "andreea toma1",
                    "empNo": "AMT1",
                    "sortEmpNo": "!!!!!AMT1",
                    "initials": "AMT",
                    "projectId": "AARSLEFF",
                    "projectDesc": "Aarsleff project I",
                    "activityId": "ACT1",
                    "activityDesc": "Aarsleff activity 1",
                    "timeTypeId": "MASKTIMER",
                    "timeTypeDesc": "",
                    "regTime": 3600,
                    "budget": 144000,
                    "dimensionId1": "10301",
                    "dimensionDesc1": "Scania Tankvogn",
                    "dimensionId2": "23669",
                    "dimensionDesc2": "Renovering af kompressor motor"
                },
                {
                    "empId": "605",
                    "empName": "andreea toma1",
                    "empNo": "AMT1",
                    "sortEmpNo": "!!!!!AMT1",
                    "initials": "AMT",
                    "projectId": "AARSLEFF",
                    "projectDesc": "Aarsleff project I",
                    "activityId": "ACT1",
                    "activityDesc": "Aarsleff activity 1",
                    "timeTypeId": "MASKTIMER",
                    "timeTypeDesc": "",
                    "regTime": 10800,
                    "budget": 144000,
                    "dimensionId1": "10357",
                    "dimensionDesc1": "Jernreol ved port 17",
                    "dimensionId2": "23669",
                    "dimensionDesc2": "Renovering af kompressor motor"
                }
            ]
        },
        "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.