The Browser API is a web service API that provides access to certain sets of data within the KxWelcome Browser system. To make use of this API you must register with the owner of the KxWelcome Browser database, who will give you appropriate access information.
The entry point is the APISession service, which provides access to the other services in the system. If you do not call this service successfully you will not be able to use any of the other services. To use this service you will need your user name, password, and customer access token - all of which will have been issued to you by the owner of the KxWelcome Browser database. To initate a session call the Get method.
You can check that you are calling the version of the API that you expect, by making a call to the Get method of the APIVersion service. Likewise, you can check that your permissions have given you access to the items you expected, by calling the Get method of the AvailableAPI service to determine the API services available to you, and calling the Get method of the AvailableDataset service to determine the datasets available to you.
When you have finished using the API you should call the Delete method on the service.
If you wish to use the API to extract information to allow you to advertise, and potentially sell, Rooms, then your starting point is the Pathway service. Making a call to the GetAll method will give you a list of all Pathways accessible by you, or if you know the ID of the specific Pathway you require you can instead call the Get method which will return the details of just the single Pathway, as long as of course it is still available to you.
The Pathway provides a summary of its details, but if you need to know more detail about any specific item other services exist to provide this information.
If you wish to use the API to extract information about existing Bookings then your starting point is the Booking service. You can also use the Property service to allow you to first identify which Properties you are interested in, before using the Booking service. Once you have details of a specific Booking, you can determine more information about an Occupant using the Occupant service.
If you wish to use the API to find Student details your starting point is the Student service.
If you wish to use the API to update Student details your starting point is the Student service. Both the Booking and Property services can be used to filter Student information when calling the Student service.