AppointmentService

public protocol AppointmentService

The AppointmentService provides access to a list of scheduled appointments with the logged in user, as well as functions to create appointments


                    
                    
                    getRetailVisits(success:failure:)

An asynchronous call to fetch a list of the patients retail visits that have been scheduled.

Internally, this will filter the appointment based on status=requested

Swift

func getRetailVisits(success: @escaping ([ScheduledVisit]) -> Void, failure: @escaping (FailedReason) -> Void)

`success`	A closure called when the call succeeds. A possibly empty array of `ScheduledVisit` objects is passed to the closure.
`failure`	A closure called when the call fails.


                    
                    
                    getCancelReasons(brandName:success:failure:)

Returns a list of CancellationReason objects that will be used in cancelRetailAppointment call

Swift

func getCancelReasons(brandName: String, success: @escaping ([CancelReason]) -> Void, failure: @escaping (FailedReason) -> Void)

`success`	A closure called with a list of `CancelReason` objects
`failure`	A closure called if any FailedReason errors are returned


                    
                    
                    cancelRetailAppointment(visitId:cancelReason:success:failure:)

Cancels an appointment

Swift

func cancelRetailAppointment(visitId: String, cancelReason: CancelReason, success: @escaping () -> Void, failure: @escaping (FailedReason) -> Void)

`visitId`	The visit id of the `ScheduledVisit` to be cancelled
`cancelReason`	Reason for cancellation selected from the `CancelReason` objects returned from `getCancelReasons(brandName:success:failure:)`
`success`	A closure called if the appointment is successfully cancelled
`failure`	A closure called if any FailedReason errors are returned