Reading Buses APIV2.1.0
A C#, .net Standard Library for the Reading Buses Open Data API (http://rtl2.ods-live.co.uk/cms/apiservice), available to use in your C# console, WPF, UWP or Win Form Applications.
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1 2 3 4]
N ReadingBusesAPI
N BusServices
C BusService Stores information about an individual bus services. Related to the "List Of Services" API
C Services This classes simply gets all the bus services operated by Reading Buses, by interfacing with the "List Of Services" API
N BusStops
C BusStop Stores information about a single bus stop. Related to the "List Of Bus Stops" API
C Locations This classes simply gets all the buses stops visited by Reading Buses, by interfacing with the "List Of Bus Stops" API
N Common
C ParseOperatorConverter Converts a string short code for an Operator into an Operator Enum and back again for the JSON converter
C ParseStringConverter Converts a string into a long and back again for the JSON converter
C Point Stores an X and Y Position simply
C UrlConstructor Returns back the URL needed to make a get command to the Reading Buses Open Data API. You can use this for testing purposes to check the API is returning what you were expecting
N ErrorManagement
C ErrorFormat Represents an error message object returned by all JSON feeds of the API
C ErrorManager Responsible for extracting and producing an error message from an API result. To the end user
C ReadingBusesApiException Stores the basic/base type of Exception which can be thrown by the API
C ReadingBusesApiExceptionBadQuery An exception type which is used when the API returns back an error message. Most likely due to an invalid request such as asking for data that does not exist
C ReadingBusesApiExceptionCritical An exception type which is thrown when the cause of the error is unknown
C ReadingBusesApiExceptionMalformedQuery An exception type which is used when the user asks to make a invalid API call This is would be thrown during checks done before even directly calling upon the web API. For example if you have not filtered by at least one property when required too
N JourneyDetails
C LiveRecord Used to store information about a buses arrival at a bus stop. Mainly related to the "Stop Predictions" API
N TimeTable
C ArchivedBusTimeTable Represents and retrieves information about a actual single time table record, which means information on one bus at one location. Related to the "Tracking History" API
C BusTimeTable Represents and retrieves information about a scheduled/predicted single time table record, which means information on one bus at one location. Related to the "Timetabled Journeys" API
C TimeTableRecord Represents the Raw timetable object data you get from the Timetabled Journeys and Tracking History APIs
C ParseBusStopConverter Converts a bus stop acto-code into a 'BusStop' Object and back again for the JSON converter
C ParseDirectionConverter Converts a string into a Direction Enum and back again for the JSON converter
C ParseTimingPointConverter Converts a string into a boolean and back again for the JSON converter
N VehiclePositions
C ArchivedPositions Stores information about previous/ archived GPS data on vehicles
C GpsController Helps get live and historical GPS data on vehicles by accessing the "Live Vehicle Positions" API
C LivePosition Used to store live information about a buses GPS position. Related to the "Live Vehicle Positions" API
C ReadingBuses This is the main class for the library, here you can initialise a singleton instance and then query and use the Reading Buses API