Customer Service

Dieser Service bietet eine Schnittstelle zum Zugriff auf die Kundendaten die in TimePunch hinterlegt sind.

CreateCustomer

Diese Methode erzeugt ein neues Kundenobjekt und liefert es zurück. Die Kundendaten sind zu diesem Zeitpunkt noch nicht in der Datenbank gespeichert.

CustomerDto CreateCustomer(  
 out TpFault fault,  
 TpAuthentication authentication);

Needed Permission	customers@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		New CustomerDTO object with the preset of customer data.

SaveCustomers

Diese Methode speichert die übergebenen Kundendaten in die Datenbank und liefert als Ergebnis die gespeicherten Daten wieder zurück.

CustomerDto[] SaveCustomers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 CustomerDto[] customers);

Needed Permission	customers@import
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
customers		Array of customer data to store in the database
Return value		The customer data that has been stored in the database.

ImportCustomers

Diese Methode importiert die übergebenen Kundendaten in die Datenbank. Der Unterschied zum Speichern ist, dass die Kundendaten nicht anhand der ID, sondern der Kunden-Ref.Nr und des Namens identifiziert werden. Bei gleicher Kunden Referenz und Namen wird der Datensatz aktualisiert.

CustomerDto[] ImportCustomers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 CustomerDto[] customers);

Needed Permission	customers@import
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
customers		Array of customer data to import in the database
Return value		The customer data that has been stored in the database.

LoadCustomers

Diese Methode lädt die mit Kundendaten der übergebenen Kunden Schlüssel. Die Methode sollte der Suche bevorzugt werden, wenn die IDs der Kundendaten bekannt sind.

CustomerDto[] LoadCustomers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] customerIds);

Needed Permission	customers@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
customerIds		Array of customer ids to load from the database
Return value		The customer data that has been loaded from the database.

MarkCustomersAsDeleted

Diese Methode markiert die Kundendaten als gelöscht. Die Daten werden dabei nicht physisch gelöscht.

void MarkCustomersAsDeleted(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] customerIds);

Needed Permission	customers@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
customerIds		Array of customer ids to mark as deleted in database

DeleteCustomers

Diese Methode versucht die Kundendaten physisch in der Datenbank zu löschen. Sollte der Kunde bereits verwendet werden, ist das physische Löschen nicht mehr möglich. In diesem Fall sollte der Kunde als gelöscht markiert werden.

void DeleteCustomers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] customerIds);

Needed Permission	customers@manage
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
customerIds		Array of customer ids to physically delete in database

SearchCustomers

Diese Methode sucht nach allen Kunden anhand des vorgegebenen Suchobjekts.

CustomerDto[] SearchCustomers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 CustomerSearchDto templateCustomer);

Needed Permission	customers@access
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
templateCustomer		Search object that holds the properties used for searching the real customers
Return value		Found customer data

SearchActiveCustomers

Diese Methode sucht nach alle aktiven Kunden anhand des vorgegebenen Suchobjekts.

CustomerDto[] SearchCustomers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 CustomerSearchDto templateCustomer);

Needed Permission	customers@access
Name	Modifier	Description
Fault	Out	Contains the error if an exception occurs.
Authentication		User authentication
templateCustomer		Search object that holds the properties used for searching the real customers
Return value		Found customer data