Skip to main content
Server path: /rentman-scheduling | Type: Application | PCID required: Yes

Tools

ToolDescription
rentman_scheduling_create_appointmentCreate Appointment item.
rentman_scheduling_create_appointment_crewCreate AppointmentCrew item.
rentman_scheduling_create_leave_mutationsCreate LeaveMutations item.
rentman_scheduling_create_leave_requestCreate LeaveRequest item.
rentman_scheduling_create_time_registrationCreate TimeRegistration item.
rentman_scheduling_create_time_registration_2Create TimeRegistration item.
rentman_scheduling_delete_appointmentDelete Appointment item.
rentman_scheduling_delete_appointment_crewDelete AppointmentCrew item.
rentman_scheduling_delete_time_registrationDelete TimeRegistration item.
rentman_scheduling_get_appointment_appointment_crew_collectionGet AppointmentCrew collection.
rentman_scheduling_get_appointment_collectionGet Appointment collection.
rentman_scheduling_get_appointment_crew_collectionGet AppointmentCrew collection.
rentman_scheduling_get_appointment_crew_itemGet AppointmentCrew item.
rentman_scheduling_get_appointment_itemGet Appointment item.
rentman_scheduling_get_leave_mutations_collectionGet LeaveMutations collection.
rentman_scheduling_get_leave_mutations_itemGet LeaveMutations item.
rentman_scheduling_get_leave_request_collectionGet LeaveRequest collection.
rentman_scheduling_get_leave_request_itemGet LeaveRequest item.
rentman_scheduling_get_leave_request_time_registration_collectionGet TimeRegistration collection.
rentman_scheduling_get_leave_types_collectionGet LeaveTypes collection.
rentman_scheduling_get_leave_types_itemGet LeaveTypes item.
rentman_scheduling_get_time_registration_activity_collectionGet TimeRegistrationActivity collection.
rentman_scheduling_get_time_registration_activity_itemGet TimeRegistrationActivity item.
rentman_scheduling_get_time_registration_collectionGet TimeRegistration collection.
rentman_scheduling_get_time_registration_file_collectionGet File collection.
rentman_scheduling_get_time_registration_itemGet TimeRegistration item.
rentman_scheduling_get_time_registration_time_registration_activity_collectionGet TimeRegistrationActivity collection.
rentman_scheduling_update_appointmentUpdate Appointment item.
rentman_scheduling_update_appointment_crewUpdate AppointmentCrew item.
rentman_scheduling_update_leave_requestUpdate LeaveRequest item.
rentman_scheduling_update_time_registrationUpdate TimeRegistration item.

rentman_scheduling_create_appointment

Create Appointment item. Parameters:
ParameterTypeRequiredDefaultDescription
colorstringNoThe color value
endstringYesThe end value
is_plannablebooleanNoIf yes, employees can be scheduled during this appointment.
is_publicbooleanNoIs Public
locationstringNoThe location value
namestringNoThe name value
remarkstringNoThe remark value
startstringYesThe start value

rentman_scheduling_create_appointment_crew

Create AppointmentCrew item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
crewstringYesThe crew value

rentman_scheduling_create_leave_mutations

Create LeaveMutations item. Parameters:
ParameterTypeRequiredDefaultDescription
crewmemberstringYesThe crewmember value
descriptionstringNoThe description value
durationnumberNoThe duration value
leavetypestringYesThe leavetype value
mutation_datestringNoMutation Date

rentman_scheduling_create_leave_request

Create LeaveRequest item. Parameters:
ParameterTypeRequiredDefaultDescription
approval_statusstringNoApproval Status
descriptionstringNoThe description value
requested_forstringYesRequested For
reviewed_onstringNoReviewed On
reviewerstringNoThe reviewer value

rentman_scheduling_create_time_registration

Create TimeRegistration item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
break_durationnumberNoBreak Duration
correction_durationnumberNoCorrection Duration
crewmemberstringNoThe crewmember value
customobjectNoThe object containing all custom defined fields.
distancenumberNoThe distance value
durationnumberNoFor time registration of worked hours, the duration will be calculated automatically based on the start and end time. For leave registrations that affect an hour balance, the duration can differ from the start and end time and should contain the number of hours that have to be deducted from the hour balance of the crew member.
endstringNoThe end value
is_lunch_includedbooleanNoIs Lunch Included
leavetypestringNoThe leavetype value
remarkstringNoThe remark value
startstringNoThe start value
travel_timenumberNoTravel Time

rentman_scheduling_create_time_registration_2

Create TimeRegistration item. Parameters:
ParameterTypeRequiredDefaultDescription
break_durationnumberNoBreak Duration
correction_durationnumberNoCorrection Duration
crewmemberstringNoThe crewmember value
customobjectNoThe object containing all custom defined fields.
distancenumberNoThe distance value
durationnumberNoFor time registration of worked hours, the duration will be calculated automatically based on the start and end time. For leave registrations that affect an hour balance, the duration can differ from the start and end time and should contain the number of hours that have to be deducted from the hour balance of the crew member.
endstringNoThe end value
is_lunch_includedbooleanNoIs Lunch Included
leavetypestringNoThe leavetype value
remarkstringNoThe remark value
startstringNoThe start value
travel_timenumberNoTravel Time

rentman_scheduling_delete_appointment

Delete Appointment item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_delete_appointment_crew

Delete AppointmentCrew item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_delete_time_registration

Delete TimeRegistration item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_appointment_appointment_crew_collection

Get AppointmentCrew collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_appointment_collection

Get Appointment collection.

rentman_scheduling_get_appointment_crew_collection

Get AppointmentCrew collection.

rentman_scheduling_get_appointment_crew_item

Get AppointmentCrew item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_appointment_item

Get Appointment item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_leave_mutations_collection

Get LeaveMutations collection.

rentman_scheduling_get_leave_mutations_item

Get LeaveMutations item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_leave_request_collection

Get LeaveRequest collection.

rentman_scheduling_get_leave_request_item

Get LeaveRequest item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_leave_request_time_registration_collection

Get TimeRegistration collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_leave_types_collection

Get LeaveTypes collection.

rentman_scheduling_get_leave_types_item

Get LeaveTypes item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_time_registration_activity_collection

Get TimeRegistrationActivity collection.

rentman_scheduling_get_time_registration_activity_item

Get TimeRegistrationActivity item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_time_registration_collection

Get TimeRegistration collection.

rentman_scheduling_get_time_registration_file_collection

Get File collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_time_registration_item

Get TimeRegistration item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_get_time_registration_time_registration_activity_collection

Get TimeRegistrationActivity collection. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype

rentman_scheduling_update_appointment

Update Appointment item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
colorstringNoThe color value
endstringYesThe end value
is_plannablebooleanNoIf yes, employees can be scheduled during this appointment.
is_publicbooleanNoIs Public
locationstringNoThe location value
namestringNoThe name value
remarkstringNoThe remark value
startstringYesThe start value

rentman_scheduling_update_appointment_crew

Update AppointmentCrew item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
crewstringYesThe crew value

rentman_scheduling_update_leave_request

Update LeaveRequest item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
approval_statusstringNoApproval Status
descriptionstringNoThe description value
requested_forstringYesRequested For
reviewed_onstringNoReviewed On
reviewerstringNoThe reviewer value

rentman_scheduling_update_time_registration

Update TimeRegistration item. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the itemtype
break_durationnumberNoBreak Duration
correction_durationnumberNoCorrection Duration
crewmemberstringNoThe crewmember value
customobjectNoThe object containing all custom defined fields.
distancenumberNoThe distance value
durationnumberNoFor time registration of worked hours, the duration will be calculated automatically based on the start and end time. For leave registrations that affect an hour balance, the duration can differ from the start and end time and should contain the number of hours that have to be deducted from the hour balance of the crew member.
endstringNoThe end value
is_lunch_includedbooleanNoIs Lunch Included
leavetypestringNoThe leavetype value
remarkstringNoThe remark value
startstringNoThe start value
travel_timenumberNoTravel Time