API Service

AWFWeatherApiClient is a subclass of AWFApiClient that interacts with the Aeris Weather API.

This class is not intended to be used directly but instead used by subclasses of AWFWeatherEndpoint to perform requests for data on specific endpoints of the API and transform them into the appropriate AWFWeatherObject model instances.

AWFWeatherApiResponse is a subclass of AWFApiResponse that is responsible for receiving a response from an Aeris Weather API request and determining whether or not the request was successful along with any warnings or errors that occurred.

AWFBatchLoader provides convenience methods for combining multiple endpoint requests into a single HTTP request using Aeris API’s batch endpoint. This request allows you to easily add and remove existing specific endpoints before performing a request.

An AWFBatchRequestOptions object is a subclass of AWFWeatherRequestOptions that includes additional parameters necessary when performing batch requests to the API.

AWFWeatherEndpoint is a concrete class that is responsible for handling all requests for a specific API endpoint. This class should not be used as is, but rather should be subclassed to provided the required configuration for interacting with the Aeris Weather API.

An AWFWeatherEndpointResult instance is returned by an AWFWeatherEndpoint object upon completion of an API request. The returned instance will contain an array of results returned by the API for the request, if any, as the respective AWFWeatherObject subclass for that endpoint. Any error that occurred during the request will also be included with the AWFWeatherEndpointResult instance.

An AWFRequesetOptions object represents all of the supported options that can be passed to an API request through AWFWeatherEndpoint instances. This is a convenience class that will properly format parameters as required by the API before the request is actually initiated.