Method

rxc-clientevent-get

Description

This method will get the details of client events.

Parameters

Name Input Value Type Description
client_id Integer This is the id of the client we are loading events for.
client_event_id Integer This is the id of the client_event.
operation_business_id Integer This is the operation we are looking for the client_event in, pass zero for all operations.
client_event_status_id Integer This status of the client_event, pass zero to load client events with any status.
employee_id Integer This is the employee we are retrieving event for, pass zero to load events for all assigned employees.
due_open_date Date This is the open date of the date range to use searching by due date.
due_close_date Date This is the close date of the date range to use searching by due date.
start_row Integer This is the start row we want to return. This is used to filter the number of records being returned.
end_row Integer This is the end row we want to return. This is used to filter the number of records being returned.
order_by Integer This tells the procedure how we want the data to be sorted 0 = ASC, 1 = DESC, 2 = Due Date, Priority, ASC
start_open_date Date This is the open date of the date range to use searching by start date.
start_close_date Date This is the close date of the date range to use searching by start date.
by_employee_id Integer This is the made employee we are retrieving event for, pass -1 to load events for all made employees.
client_event_type_id Integer This is the type assigned to this event, pass -1 to load all client event types.
completion_open_date Date This is the open date of the date range to use searching by completion date.
completion_close_date Date This is the close date of the date range to use searching by completion date.
department_id Integer (Optional) If non-zero, only the events belonging to this department will be returned. Default is 0
format enumeration (optional) Set this value to "xml" for XML raw formatted output, "xml-clean" for XML tidy formatted output or "json" for JSON formatted output. If not passed, "xml" is used as a default

XML Encoded Request

URL Encoded Request





Result