SolarNetwork Core

Mixin: LocationDatumMetadataUrlHelperMixin

net~ LocationDatumMetadataUrlHelperMixin

A mixin class that adds SolarNode datum metadata support to module:net~UrlHelper.

Location datum metadata is metadata associated with a specific location and source, i.e. a locationId and a sourceId.

Methods

addLocationDatumMetadataUrl( [locationId] [, sourceId])

Generate a URL for adding (merging) datum metadata via a POST request.

Parameters:
Name Type Argument Description
locationId number <optional>

a specific location ID to use; if not provided the locationId property of this class will be used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used
Returns:

the URL

Type
string

deleteLocationDatumMetadataUrl( [locationId] [, sourceId])

Generate a URL for deleting datum metadata via a DELETE request.

Parameters:
Name Type Argument Description
locationId number <optional>

a specific location ID to use; if not provided the locationId property of this class will be used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used
Returns:

the URL

Type
string

findLocationDatumMetadataUrl( [filter] [, sorts] [, pagination])

Generate a URL for searching for location metadata.

Parameters:
Name Type Argument Description
filter module:domain~DatumFilter <optional>

a search filter; the locationIds, sourceIds, tags, query, and location properties are supported
sorts Array.<module:domain~SortDescriptor> <optional>

optional sort settings to use
pagination module:domain~Pagination <optional>

optional pagination settings to use
Returns:

the URL

Type
string

replaceLocationDatumMetadataUrl( [locationId] [, sourceId])

Generate a URL for setting datum metadata via a PUT request.

Parameters:
Name Type Argument Description
locationId number <optional>

a specific location ID to use; if not provided the locationId property of this class will be used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used
Returns:

the URL

Type
string

viewLocationDatumMetadataUrl( [locationId] [, sourceId])

Generate a URL for viewing datum metadata.

If no sourceId is provided, then the API will return all available datum metadata for all sources.

Parameters:
Name Type Argument Description
locationId number <optional>

a specific location ID to use; if not provided the locationId property of this class will be used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used; if null then ignore any sourceId property of this class
Returns:

the URL

Type
string