Retrieves a set of appointments based on specified search criteria. If the criteria is empty, then the search will retrieve all appointments. The specified limit takes precedence over the current system setting for the maximum number of search results. For a list of available properties, see the type class, appointment.
Parameters
readAppointmentsByCriteria Parameter Descriptions
Parameter Name |
Data Type |
Description |
criteria |
searchCriteria |
Search criteria or conditions to search for. |
limit |
int |
A numeric value for the maximum number of records to return among search results. |
properties |
List<String> |
A list of String values that identify the property names whose values to return with the resulting appointment records. |
Response
readAppointmentsByCriteria Response Descriptions
Parameter Name |
Data Type |
Description |
appointments |
List<appointment> |
A list of appointment objects. Only specified property values are returned with the record. |
See Also:
appointment for more information about the properties you can retrieve
