Method

rxc-clientsearch-get

Description

This method will get the details of client events.

Parameters

Name Input Value Type Description
business_code Integer (Optional) This is a unique identifier that represents the business we are getting availability for. If not specified, the business associated with the logged in user's session is used.
operation_business_id Integer (Optional) This is a unique identifier that represents the operation we are searching for businesses within. If set to 0 or not specified, all operations are searched.
client_type_id Integer This is the id of the client_type, pass 1 for business client, pass 0 for persons.
date_type_id Integer This is the id of the date search option. 0=no date search, 1=Reservation with dates, 2=membership within dates, 3=membership expire within dates
open_date Timestamp (Optional) This is the start date we are using to find any reservation with a check out date greater than this date. Only used if Rez_ID is not passed in.
close_date Timestamp (Optional) This is the end date we are using to find any reservation with a check in date less than this date. Only used if Rez_ID is not passed in.
searchby1_id Integer This is the id of the first search criteria value.
searchby1_string String This is the string value that we are searching for.
searchby2_id Integer This is the id of the second search criteria value.
searchby2_string String This is the string value that we are searching for.
searchby3_id Integer This is the id of the third search criteria value.
searchby3_string String This is the string value that we are searching for.
activeonly Integer 1 = Active Only, 0 = All memberships, 2 = Inactive Only, 3 = Suspended
inclbookbus Integer Include active in commerce business types, if applicable.
defbusiness_id Integer Return clients (persons) with this default business.
inclholding Integer Include memberships belonging to holding operations 0 = No, 1 = Yes.
expirestatus_id Integer 0 = All, 1 = Expired Only, 2 = Not Expired Only.
member_type_id Integer This is the id of the member type we are searching for.
person_search_enabled Integer Set to non-zero, this indicates we are searching from the person search control.
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