Change Request Time Entry Service

This service defines all methods for working with change requests for time entries in TimePunch. It is used to search for, review, approve or reject requested changes.

---

GetChangeRequestCountAndDate

Returns the number of change requests and the date of the last change request.

Tuple<int, DateTime> GetChangeRequestCountAndDate(
    out TpFault fault,
    TpAuthentication authentication,
    ChangeRequestTimeEntrySearchDto searchDto);

Needed Permission	changeRequests@access
fault	Out	Contains the error if an exception occurs.
authentication		Authentication object with the user credentials.
searchDto		Search criteria for change requests.

---

SearchChangeRequestTimeEntries

Searches for change requests that match the specified search criteria.

List<ChangeRequestTimeEntryDto> SearchChangeRequestTimeEntries(
    out TpFault fault,
    TpAuthentication authentication,
    ChangeRequestTimeEntrySearchDto searchDto);

Needed Permission	changeRequests@access
fault	Out	Contains the error if an exception occurs.
authentication		User authentication.
searchDto		Contains the search parameters for change requests.

---

GetAllChangeRequestsByApprover

Reads all change requests assigned to a specific approver.

List<ChangeRequestTimeEntryDto> GetAllChangeRequestsByApprover(
    out TpFault fault,
    TpAuthentication authentication,
    Guid approverId);

Needed Permission	changeRequests@access
fault	Out	Contains the error if an exception occurs.
authentication		User authentication details.
approverId		The ID of the approver.

---

DeleteChangeRequestTimeEntries

Deletes change requests based on a list of time booking IDs.

void DeleteChangeRequestTimeEntries(
    out TpFault fault,
    TpAuthentication authentication,
    List<Guid> entryIds);

Needed Permission	changeRequests@access
fault	Out	Contains the error if an exception occurs.
authentication		Authentication object.
entryIds		List of IDs of the change requests to be deleted.

---

DeclineChangeRequestTimeEntry

Declines a change request.

void DeclineChangeRequestTimeEntry(
    out TpFault fault,
    TpAuthentication authentication,
    Guid crTimeEntryId,
    string declineReason);

Needed Permission	changeRequests@manage
fault	Out	Contains the error if an exception occurs.
authentication		Authentication object.
crTimeEntryId		ID of the change request to be declined.
declineReason		Reason for the rejection.

---

ApplyChangeRequestTimeEntry

Takes an approved change request and applies it to the time entry.

TimeEntryDto ApplyChangeRequestTimeEntry(
    out TpFault fault,
    TpAuthentication authentication,
    Guid crTimeEntryId);

Needed Permission	changeRequests@manage
fault	Out	Contains the error if an exception occurs.
authentication		Authentication data.
crTimeEntryId		ID of the change request to be applied.

---

SaveChangeRequestTimeEntry

Validates and saves a change request for a time entry.

ChangeRequestTimeEntryDto SaveChangeRequestTimeEntry(
    out TpFault fault,
    TpAuthentication authentication,
    ChangeRequestTimeEntryDto crTimeEntry,
    List<CustomFieldContentDto> customFieldContents);

Needed Permission	changeRequests@access
fault	Out	Contains the error if an exception occurs.
authentication		Authentication object.
crTimeEntry		The change request to be validated and saved.
customFieldContents		List of custom fields for the time entry.

---

GetChangeRequestTimeEntry

Reads an existing change request by its ID.

ChangeRequestTimeEntryDto GetChangeRequestTimeEntry(
    out TpFault fault,
    TpAuthentication authentication,
    Guid crTimeEntryId);

Needed Permission	changeRequests@access
fault	Out	Contains the error if an exception occurs.
authentication		User authentication.
crTimeEntryId		ID of the change request.

---

GetChangeRequestApprover

Reads the approvers for specific user IDs.

List<ChangeRequestApproverDto> GetChangeRequestApprover(
    out TpFault fault,
    TpAuthentication authentication,
    List<Guid> userIds);

Needed Permission	changeRequests@access
fault	Out	Contains the error if an exception occurs.
authentication		Authentication object.
userIds		List of user IDs for which the approvers are queried.

---

SetChangeRequestApprover

Sets or updates the approver for change requests.

void SetChangeRequestApprover(
    out TpFault fault,
    TpAuthentication authentication,
    ChangeRequestApproverDto approver);

Needed Permission	changeRequests@admim
fault	Out	Contains the error if an exception occurs.
authentication		Authentication data.
approver		The approver to be set.

---

DeleteChangeRequestApprover

Deletes the approver for a specific user.

void DeleteChangeRequestApprover(
    out TpFault fault,
    TpAuthentication authentication,
    Guid userId);

Needed Permission	changeRequests@admim
fault	Out	Contains the fault if an exception occurs.
authentication		User authentication.
userId		User ID whose approver is to be deleted.