Click or drag to resize

DataSetsGetBaseWithKey Method

For unusual use cases, this enables you to access the DataSetBase objects using the string keys that are usually managed internally.

Namespace: DegreeDays.Api.Data
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
public DataSetBase GetBaseWithKey(
	string key
)

Parameters

key  String
A non-null, non-empty string key that you expect to be present in the response, associated with the set of data that you want to access.

Return Value

DataSetBase
The non-null DataSetBase associated with key (matching a data specification with key key from the original request).
Exceptions
ExceptionCondition
SourceDataExceptionThere was a failure in the API's processing of the data specification associated with key.
ArgumentNullExceptionkey is null.
ArgumentExceptionkey isn't recognized as a key from this response.
Remarks

Usually you'll want the methods that take a DataSpec (or subclass) instead of this one, but you might need this method if you are:

  1. generating your XML requests outside of this framework; or
  2. creating the string keys used by DataSpecs yourself; or
  3. testing an XML IResponseParser that you have written.
See Also