Method

rxc-clientnotes-get

Description

This method will get the details of the client note passed in.

Parameters

Name Input Value Type Description
note_id Integer (Optional) This is the id of the note we are looking for. If not specified or is set to 0, multiple notes are returned based on the additional parameters specified.
employee_id Integer (Optional) If note_id is set to 0, this field is used to select the employee to return notes for. Notes assigned to the employee's department are also returned. If not specified, the default is 0 (all employees).
client_id Integer (Optional) If client id is set to 0, this field is used to select the client to return notes for. If not specified, the default is 0 (all clients).
operation_business_id Integer This is the operation id the client associate to note exists within.
status_id Integer (Optional) If not specified, the default is 0 (all statuses).
open_date Date (Optional) When note_id is set to 0, this field is required and only notes that are created between open_date and close_date are returned.
close_date Date (Optional) When note_id is set to 0, this field is required and only notes that are created between open_date and close_date are returned.
sort_order Integer (Optional) This will specify the sort order we would like the data returned. 0 For Create_Time Newest to Oldest, 1 For Employee - then create_time newest to oldest
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.
note_type_id Integer (Optional) Default of zero will return all note types.
department_id Integer (Optional) If client id is set to 0 and department_id is non-zero, only the notes assigned 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