Outcomes:
GET Appointment to view details on an appointment
Enable a development to send a GET request using datetimestamp. All appointments with Last Modified Date Time after the datetimestamp will be returned.
IF datetimestamp is valid, return all values on an Appointment in the Payload with a 200 success message
IF datetimestamp is not valid, then return a 400 error that “This datetimestamp is not valid”
Field | Data Type | Max Length | Description | Required | Expected Values | Errors | |
|---|---|---|---|---|---|---|---|
| 1 | appointmentTypeId | number | 1 | Type of appointment. Send ID associated to the Appointment Type. Refer Appointment Type Appendix. | Yes | 1 | Appointment Type does not match system set values. |
| 2 | appointmentId | number | 15 | Appointment ID. This will be null in case a new appointment is being created. Rethink will assign an AppointmentID. If the appointment is being updated, the AppointmentID will need to be sent to Rethink | Situational; Required for update appointments | 4758488 | Submitted AppointmentID does match any IDs associated with this Company Account |
| 3 | date | string | 10 | Date of Service | Yes | 2020-12-12 | Must be date format |
| 4 | scheduledStartTime | string | 5 | Scheduled Start Time of the appointment. Times should be sent in UTC | Yes | 16:00 | Must be time format |
| 5 | scheduledEndTime | string | 5 | Scheduled End Time of the appointment. Times should be sent in UTC. | Yes | 17:00 | Must be time format |
| 6 | staffId | number | 20 | Staff ID should be same as the ID returned by Rethink when Staff was created | Yes | 1234 | Submitted StaffID does match any IDs associated with this Company Account |
| 7 | payCodeId | number | 10 | Pay Code ID should match the Pay Codes configured in Staff Profile > Pay Code. IDs for Paycodes will be provided by Rethink during implementation Pay Code ID transmitted should also be configured in the Staff Member Profile. | Yes | 12345 | Invalid format Submitted value does match any IDs associated with a Paycode |
| 8 | tagId NEEDS GROOMING | number | Tag Id should match the Id of the Tag configured in the Company Account > Scheduling. Tag Id is required for non-billable appointments Error will be returned if Appointment Type is Billable and Tag sent is Non-Billable. Error will be returned if Appointment Type is Non-Billable. and Tag sent is Billable. | Situational | 123 | Invalid Tag Id Invalid Tag Id for Billable Appointment Invalid Tag Id for Non-Billable Appointment | |
| 9 | clientId | number | 20 | Should be same as the Client ID returned by rethink when client was created | Yes | 12345 | Submitted ClientID does match any IDs associated with this Company Account |
| 10 | locationCodeId | number | 2 | Place of Service to denote the location where the appointment was performed i.e. 03-School See Place of Service Data Dictionary to see expected values | Yes | 1 | Place of Service ID does not match expected Place of Service values: |
| 11 | locationId | number | 100 | Location should EXACTLY MATCH be one of the following number values:
| No | 1 | Value does not match ID for Locations |
| 12 | scheduledLocationAddress | string | 500 | Address associated with the scheduled location of the appointment IF location is sent as 1 (Client Home), scheduled location address can be blank. The address present in the Client Profile will be auto populated as scheduled location address. IF location is sent as 2 (Staff Home), scheduled location address can be blank. The address present in the Staff Profile will be auto populated. IF back-end ID of a location is sent, address associated with the location in Company Account will be auto-populated. Any address passed in this field will over-ride the auto-population logic for addresses. | No | 123 Avenue, NY, NY, 07202 | Exceeds max length |
| 13 | authorizationBillingCodeId | number | 10 | If a new service is added to the Authorization, this field can be blank. Rethink will assign an Authorization Billing Code ID and return the Authorization Billing Code ID. Any further updates to the Authorization Service will require the Authorization Billing Code ID. | Situational | 11134 | Invalid format Invalid Authorization Billing Code ID. |
| 14 | funderBillingCodeId | number | 10 | If appointment is created for a Billing Code that has Does NOT require Authorization setting checked on Funder THEN the Funder Billing Code needs to be sent. | Situational | 11134 | Billing Code does not match values under Company Account Current Values: [Show Company Values] |
| 15 | cancellationTypeId | number | 1 | Marks an appointment as Family Cancelled or Staff Cancelled. See Appendix 11.0. Cancellation Types. | No | 1 | Invalid Format Invalid Cancellation Type ID Expected Values: 1 - Staff Member 2 - Client |
| 16 | cancellationSubtypeId | number | 10 | Selects a cancellation sub-type for the cancellation. ID associated to Cancellation sub-types configured in Company Account > Scheduling > Cancellation Types should be transmitted. Cancellation Type IDs will be provided by Rethink during implementation. | Situational; if cancellation type is sent; cancellation sub-type is required | 1 | Invalid Format Invalid Cancellation Sub-type ID Expected Values: [Show ID and associated cancellation sub-type value] |
| 17 | actualStartTime | string | 20 | Actual Start Time of the Appointment. Times must be in UTC format. | No | 17:05 | Value must be time format. For example: 17:05 |
| 18 | actualEndTime | string | 20 | Actual End Time of the Appointment. Times must be in UTC format. | No | 17:55 | Value must be time format. For example: 17:55 |
| 19 | staffVerificationDateTime | string | 20 | Staff Verification Timestamp. Must be in UTC. | No | 2016-12-20T17:55:00Z | Value must be time format. For example: 2016-12-20T17:05:00Z |
| 20 | parentVerificationDateTime | string | 20 | Parent Verification Timestamp. Must be in UTC. | No | 2016-12-20T17:55:00Z | Value must be time format. For example: 2016-12-20T17:05:00Z |
| 21 | scheduledLocation | ||||||
| 22 | latitude | number | 11 | Scheduled location latitude returned for EVV Appointments | No | 25.555903 | Value provided cannot exceed 11 numbers. |
| 23 | longitude | number | 11 | Scheduled location longitude returned for EVV Appointments | No | -80.394343 | Value provided cannot exceed 11 numbers. |
| 24 | actualStartLocation | ||||||
| 25 | latitude | number | 11 | Start location latitude returned for EVV Appointments | No | 25.555903 | Value provided cannot exceed 11 numbers. |
| 26 | longitude | number | 11 | Start location longitude returned for EVV Appointments | No | -80.394343 | Value provided cannot exceed 11 numbers. |
| 27 | actualEndLocation | ||||||
| 28 | latitude | number | 11 | End location latitude returned for EVV Appointments | No | 25.555903 | Value provided cannot exceed 11 numbers. |
| 29 | longitude | number | 11 | End location latitude returned for EVV Appointments | No | -80.394343 | Value provided cannot exceed 11 numbers. |
| 30 | parentSignature | string | jpeg | Encoded Image of the parent verification signature. Will be used mainly for the GetAppointments API. Base64 image file. | No |
| Invalid image format. |