TimePunch Logging Service
ActiveTimeEntryDto
Diese Klasse enthält die Daten des aktiven Zeiteintrags. Der aktive Zeiteintrag ist der, für den zum Zeitpunkt der Abfrage eine Zeiterfassung läuft.
| Datatype | Name | Description |
|---|---|---|
| Guid | Id | Unique ID of the active time entry |
| DateTime | LastUpdate | Time stamp of the last update |
| Guid | ProjectId | Unique project Id for that the time tracking has been started. |
| String | ProjectName | Name of the project for that the time tracking has been started. |
| Guid | TaskId | Unique Task Id, if the time tracking has been started for a specific task. |
| String | TaskName | Name of the task, if the time tracking has been started for a specific task. |
| String | Description | Description of the current time entry. |
| DateTime | LogonTime | Start time of the current time tracking. |
| Double | BreakTime | Amount of break time in hours within the current time tracking. |
| DateTime | BreakStartTime | Start time of the current break, if the user started a break. |
| DateTime | BreakEndTime | End time of the last break, if the break has been finished. |
| TimeEntry-LoggingState | LoggingState | Defines the state of the current logging (NoActiveEntry, WorkTimeLogging, BreakTimeLogging) |
| Long | BackgroundColor | Background colour of the project that gets tracked. |
| Long | TextColor | Text colour of the project that gets tracked. |
| DateTime | LockTime | Timestamp where the PC got locked due to a screensaver event etc. |
| String | LogonName | Dependent TimePunch profile |
| Datatype | Name | Description |
| Guid | UserId | Id of the user dependent TimePunch Profile |
| String | CustomerName | Name of the customer that has been set for the time entry. |
| String | CustomerRefNr | Ref.Nr. of the customer that has been set for the time entry |
| Guid | CustomerId | Unique customer Id |
| Bool | IsImportant | True, if the time entry has been marked as important. This will force the project report to show the description. |
| Bool | IsOnsite | True, if the time entry has been marked as onsite. |
| String | ProjectDescription | Gets the project description |
| String | TaskNameId | Gets the displayed task id |
| String | TaskDescription | Gets the task description |
| TimeEntryType | Usage | Gets the usage of the active time entry |
| String | TimeZone | Gets the timezone where the active time entry belongs too |
| Bool | IsNotInvoiced | True, if the active time entry gets not invoiced at all. |
ActiveTimeEntrySearchDto
Diese Klasse ist abgeleitet von PagingContextDto. Mit Hilfe dieser Klasse wird ein Filter zum Suchen von aktiven Zeiteinträgen definiert.
| Datatype | Name | Description |
|---|---|---|
| List\<Guid> | FilteredProjects | If null, all projects will be returned. If the collection is empty, nothing will be returned. If the collection is filled with project ids, only entries with the given project ids will be returned. |
| List<\Guid> | FilteredTasks | If null, all tasks will be returned. If the collection is empty, nothing will be returned. If the collection is filled with task ids, only entries with the given task ids will be returned. |
| List<\Guid> | FilteredUsers | If null or empty, the data of the current user will be returned. If the collection is filled with, only entries with the given user ids will be returned. |
LoggingContextDto
Der Logging Context enthält alle Daten die für einen möglichen TimePunch Client für die Protokollierung der Arbeitszeit notwendig sind.
| Datatype | Name | Description |
|---|---|---|
| List\<ProjectDto> | ActiveProjects | Collection containing all projects the user can book times. |
| List\<TaskDto> | CommonTasks | Collection of common tasks |
| ActiveTimeEntryDto | ActiveTimeEntry | Active time entry, if a logging has been started. |
| LoggingSettingsDto | Settings | Logging Settings for the current user |
| List\<TimeEntryDto> | TodayEntries | Collection of time entries of the current day |
| Guid | ProposedProjectId | Id of the Project that should be used to start the next time recording. |
| Guid | ProposedTaskId | Id of the Task that should be used with the next time recording. |
| TimeAccountDto | TimeAccount | Current time account information. |
| List\<CustomerDto> | Customers | List of customers the user can choose from. |
| UserProfileDto | UserProfile | User profile to that the logging context belongs. |
LoggingSettingsDto
Diese Klasse enthält die Protokollierungseinstellungen für ein TimePunch Profil.
| Datatype | Name | Description |
|---|---|---|
| Bool | InstantLogging | Value indicating whether the time recording shall start directly after starting the TimePunch Watcher. |
| Recording-Mode | RecordingMode | Value indicating in which recording mode the TimePunch Watcher shall be used (Complex, Simple, Orwell) |
| Int | RemaindUserAfterMinutes | Amount of minutes after that the user shall get a reminder. |
| Int | TimeRecordingPrecision | Recording precision in minutes |
| Double | MaxTimeOfInactivity | Gets max. Time of inactivity before an automatic break will be started. |
| Guid | DefaultProjectId | Default project id to start the first logging |
| String | DefaultProjectName | Default project name |
| Guid | DefaultTaskId | Default task id to start the first logging |
| String | DefaultTaskName | Default task name |
| Default-ProjectMode | DefaultProjectMode | Defines if the recording shall start with a fixed project or with the project that has been used for the last time recording. |
| UserProfileDto | UserProfile | The user profile to which the logging settings belongs. |
| GPSTracking | GPSTracking | Defines if the gps tracking is dnied, optional or mandatory. (deny = -1, optional = 0, mandatory = 1) |