TimePunch Project Service

Dieser Service enthält Methoden um mit den Projekten von TimePunch zu arbeiten.

CreateProject

Diese Methode erzeugt ein neues Projekt und gibt es zurück. Das Projekt wird dabei direkt beim Anlegen in der Datenbank gespeichert und mit den Standardwerten gefüllt.

ProjectDto CreateProject(  
 out TpFault fault,  
 TpAuthentication authentication,  
 string projectId,  
 string projectDescription,  
 string projectCode,  
 Guid? copyFromProject);

Needed Permission	projects@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectId		Unique identifier of the project
projectDescription		Short description of the project
projectCode		Unique identifier that can be used by a barcode reader
Guid?		Id of the project that shall be used as a template, or NULL.
Return value		Returns the created project

DeleteProject

Diese Methode löscht ein Projekt in der Datenbank. Ein Projekt kann jedoch nur gelöscht werden, wenn keine Zeiteinträge das Projekt referenzieren. Wird das Projekt referenziert, dann empfiehlt sich ein Soft-Delete. D.h. das Lösch-Flag in der Projekt Entität muss gesetzt werden.

void DeleteProject(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid projectId);

Needed Permission	projects@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectId		Id of the project that shall be deleted

ExportProjectUserRelations

Diese Methode exportiert die Mitarbeiterspezifischen Einstellungen für ein oder mehrere Projekte.

List<ProjectUserRelationDto> ExportProjectUserRelations(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ProjectSearchDto projectSearch);

Needed Permission	projects@export
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
searchCriteria		Criteria that are used for searching the projects.
Return value		Collection of project related user data

GetProjectUsers

Diese Methode liefert eine Liste mit TimePunch Profilen die auf bestimmte Projekte buchen dürfen.

List<ProjectUserDto> GetProjectUsers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] projectIds);

Needed Permission	projects@report
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectIds		Collection of project ids to load the project relevant times
Return value		List of project / user combinations that are allowed to book the relevant project ids. It also contains the scheduled work and the pool type (Shared / Private)

GetTotalProjectTimes

Diese Methode wird dazu verwendet um die aktuellen Projektzeiten für die übergebenen Projekte und Mitarbeiter abzurufen.

List<ProjectTimeDto> GetTotalProjectTimes(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] projectIds,  
 Guid[] userIds);

Needed Permission	UserIds == null ? projects@access : projects@report
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectIds		Collection of project ids to load the project relevant times
userIds		User ids of all users for which the project data shall be loaded, or null to load the data for the current user.

ImportProjects

Diese Methode importiert eine Liste von Projekten. Im Gegensatz zu der Save Methode werden nicht die Projekt IDs, sondern der Projektname zur Identifizierung verwendet.

void ImportProjects(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<ProjectDto> projects);

Needed Permission	projects@import
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projects		Collection of projects to import

ImportProjectTasks

Diese Methode importiert eine Liste mit projektabhängigen Tätigkeiten. Die Tätigkeiten werden über den Beschreibungstext und nicht über die Tätigkeiten-ID identifiziert.

void ImportProjectTasks(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<ProjectTaskDto> projectTasks);

Needed Permission	projects@import
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectTasks		Collection of project dependend tasks to import

ImportProjectUserRelations

Diese Methode importiert die Mitarbeiterzuordnungen zu einem Projekt. Im Gegensatz zu der SaveProjectUserRelations Methode werden die Mitarbeiter nicht über die technische ID sondern überrn den Anmeldenamen zugeordnet.

void ImportProjectUserRelations(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<ProjectUserRelationDto> userRelations);

Needed Permission	projects@import
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userRelations		Collection of project user relations tasks to import

LoadProject

Diese Methode lädt das Projekt mit der übergebenen Projekt-Id.

ProjectDto LoadProject(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid projectId);

Needed Permission	projects@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectId		Id of the project to load
Return value		The loaded project data

LoadProjectUserRelations

Diese Methode lädt die Mitarbeiterspezifischen Einstellungen eines Projekts für alle authorisierten Mitarbeiter.

List<ProjectUserRelationDto> LoadProjectUserRelations(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid projectId);

Needed Permission	projects@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectId		Id of the project to load
Return value		Collection of user specific project data

MarkProjectsAsDone

Diese Methode setzt das Lösch-Flag im Projekt und markiert damit das Projekt als abgeschlossen. D.h. es können keine neuen Zeiteinträge auf das Projekt gebucht werden. Bestehende Zeiteinträge bleiben jedoch erhalten und referenzieren weiterhin das Projekt.

void MarkProjectsAsDone(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] projectIds);

Needed Permission	projects@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectIds		Collection of project ids to set the soft delete flag

SaveProject

Diese Methode speichert das Projekt in der Datenbank ab.

ProjectDto SaveProject(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ProjectDto project);

Needed Permission	projects@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
project		Project data that shall be stored
Return value		The stored project data will be returned

SaveProjectUserRelations

Diese Methode aktualisiert die Mitarbeiterzuordnung in den Projekten.

void SaveProjectUserRelations(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<ProjectUserRelationSaveDto> userRelations);

Needed Permission	projects@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userRelations		List of user and project related data.

SearchAuthorizedProjects

Diese Methode sucht nach Projekten, bei denen der Mitarbeiter authorisiert ist, mit den übergebenen Suchkriterien. Die gefundenen Projekte werden zurückgeliefert. Authorisierte Projekte sind alle Projekte die dem Mitarbeiter zugeordnet wurden.

List<ProjectDto> SearchAuthorizedProjects(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ProjectSearchDto searchCriteria);

Needed Permission	projects@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
searchCriteria		Criteria that are used for searching the projects.
Return value		Collection of found projects

SearchReportingProjects

Diese Methode sucht nach Projekten, bei denen der Mitarbeiter berechtigt ist, Berichte zu fahren. Die gefundenen Projekte werden zurückgeliefert. Es werden alle Projekte zurückgegeben, für die der Mitarbeiter selbst, oder einer seiner –in den Gruppen - zugeordneten Mitarbeiter berechtigt ist.

List<ProjectDto> SearchReportingProjects(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ProjectSearchDto searchCriteria);

Needed Permission	projects@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
searchCriteria		Criteria that are used for searching the projects.
Return value		Collection of found projects

SearchProjects

Diese Methode sucht in allen Projekten mit den übergebenen Suchkriterien. Die gefundenen Projekte werden zurückgeliefert.

List<ProjectDto> SearchProjects(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ProjectSearchDto searchCriteria);

Needed Permission	projects@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
searchCriteria		Criteria that are used for searching the projects.
Return value		Collection of found projects

SetProjectLifeCycle

Diese Methode setzt den aktuellen Lebenszyklus eines oder mehreren Projekten. Der Lebenszyklus gibt an, wie das Projekt in TimePunch verwendet werden kann.

public enum ProjectLifeCycle

{

/// Life cycle is undefined

Undefined,

/// The project can be changed, but not booked

Planning,

/// The project can be changed and booked

Active,

/// The project can not be changed, not booked, but reported

Done,

/// The project can not be changed, not booked and is not visible for reporting

Deleted,

}

void SetProjectLifeCycle(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] projectIds,  
 ProjectLifeCycle projectLifeCycle);

Needed Permission	projects@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projectIds		Collection of project ids for that the life cycle shall be changed.
projectLifeCylce		The new life cycle to set