ex_metra v0.1.1 API Reference

Modules

Represents a response from the agency API call

Represents a response from the calendar API call

Represents a response from the calendar_dates API call

Represents a response from the shapes API call

Represents a response from the stop API call

Represents a response from the stop_time API call

Represents a response from the trip API call

A collection of functions that are used to help with conversions

This is the module that interacts with the Metra JSON API. It uses HTTPoison as the base in order to make the actual calls. It will use the same functions as HTTPoison. Because of the fact that it uses the @endpoint as the base of the url, it will only be able to be used to call the Metra API. Do not use this if you are looking to make calls to other websites or services. Do note that basic authorization will already be present in the web calls so it is not necessary to add the headers when making a request. Because Basic Authorization is already included it is important to set the necessary values in your config.exs. The following values must be present in your config.exs for any web calls to be successful

This is a behaviour that requires two functions to be implemented: url and from_json. This is currently used for all structs that are going to be used with the ExMetra protocol as that protocol relies on the functions url/0 and from_json/1 to be implemented in order to properly execute