Generic Appointment & Reservation API
This API defines the web service you must implement to enable Arghon users to send reservation and appointment requests to your business. This API is used by service providers such as doctors, dentists, restaurants, etc.
Note: This API is not used for hotel/auto rentals/reservations, those have additional requirements.
Appointment & Reservation API XSD File
Click here for the generic appointment & reservation API XSD File.
Unsolicited Appointment & Reservation Updates
This API allows businesses to post updates to users existing appointments or reservations in the Arghon Ecosystem.
After a reservation or appointment is made, a company can continue to send communicationResponse until the appointment/reservation has expired.
Note: We strongly discourage multiple updates to an existing reservation/appointment. If this is abused, we will disable this feature for your company.
Data Formats Sent and Received
HTTPS POST - XML
XML API Parameters
For future use. Defaults value = 1
The type of service being requested.
reservation_request, appointment_request, appointment_cancel
see ServiceRequestType in XSD files for list of values.
Your developer key.
This is your transaction ID. It allows your web-service to map Arghon requests to ones in your system.
For new requests initiated by Arghon, the value will be left blank. We will however, include it in all followup interactions.
Transactionid should be valid across interaction sessions (until the request/reservation has expired).
This ID is generated by Arghon and is used to identify all requests in our system.
This ID must be included in ALL communication responses to Arghon.
customerid is used by service providers such as doctors to identify an Arghon user in their system.
This could be a customer number or social security number - it is up to each service provider to determine what this field is used for.
This customer id should be provided to the Arghon user so they'll have it when configuring your business as their service provider.
Note: Many businesses use the user's email or phone number as customerid to uniquely identify their customers or clients.
For businesses such as restaurants, this ID is not be needed and will be set to an empty string.
The first name of the Arghon user making the request.
The last name of the Arghon user making the request.
The phone number of the Arghon user making the request.
The email address of the Arghon user making the request.
Free form text that describes the subject/services the user is requesting. May be empty.
The number of persons this reservation/appointment is for.
The date and time the appointment/reservation is for.
When more than one timerange is included, the user will accept a reservation/appointment with any of the time slots listed.
API Response XML Fields
For future use. Defaults value = 1
This is the same value that was passed in the request's servicerequested field.
This is your transaction/system ID for tracking this interaction.
The transaction will be included in all follow up correspondence between Arghon and your web-service.
The transaction ID should be valid until the appointment,reservation, etc. has expired.
This is the ID that was sent in the request. The ID was generated by Arghon and is used to identify all requests in our system.
This ID must be included in this response or it will be rejected.
A message that describes the error if the request was not successful.
If the request is successful, a single timerange should be returned with the time slots selected.
If the time slot requested is not available the web-service may respond with up to five alternate timerange ranges. These will be presented to the user to make a selection.
The URL Arghon connects to when sending appointments/reservations is specified by you on the developer profile page
Example Appointment Request XML
<developerkey>your Arghon developer key</developerkey>
<subject>I would like an appointment for 10AM on Friday.</subject>
Example Successful Appointment Response
Example Unsuccessful Appointment Response
<errormessage>The time requested is unavailable, alternatives are listed</errormessage>