GetServices

Gets available services

JavaScript library method 

patientportal.anonappointment.getServices({
    payerType: <payer-type>,
    appointmentType: <appointment-type>,
    serviceType: <service-type>,
    serviceName:<service-name>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb URL
GET /patientportalapi/anon-appointment/services

URL Parameters

Parameter Type Description
payer-type string The signup code of a chargeband, that will provide eligibility and price information for the search.
appointment-type string Type of the appointment provided by the API upon GetAppointmentTypes
service-type string (optional) Key of the service type to filter services by, provided by GetServiceTypes
service-name string (optional) Name of service to filter services by.
page-sort-column int (optional)

The column index to sort the result:

  • 0 – Name
  • 1 – Code
  • 2- Service Type
  • 3- ServiceId

Default: 0,2
page-sort-descending int (optional) True to sort result descending. Default false.
page-number int (optional) Required page number. Default 1.
page-size int (optional) Required page size. Default 10. Minimum 5. Maximum 50.

Returns

ServiceData[]

Remarks

If no services are returned for the appointment type, either the appointment type does not allow additional services or no services exist in self book rule.