services meteringCategoryRouteService

baasicMeteringCategoryRouteService

Baasic Metering Category Route Service provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Metering Category Route Service to obtain a needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.

---

baasicMeteringCategoryRouteService.find()

Parses find metering category route which can be expanded with additional options. Supported items are:

• searchQuery - A string value used to identify metering resources using the phrase search.
• page - A value used to set the page number, i.e. to retrieve certain metering subset from the storage.
• rpp - A value used to limit the size of result set per page.
• sort - A string used to set the metering property to sort the result collection by.
• embed - Comma separated list of resources to be contained within the current representation.

Example:

baasicMeteringCategoryRouteService.find.expand({searchQuery: '<search-phrase>'});               

baasicMeteringCategoryRouteService.get()

Parses get route; this route doesn't expose any properties.

Example:

baasicMeteringCategoryRouteService.get.expand({});               

baasicMeteringCategoryRouteService.create()

Parses create metering category route; this URI template does not expose any additional options.

Example:

baasicMeteringCategoryRouteService.create.expand({});              

baasicMeteringCategoryRouteService.parse()

Parses and expands URI templates based on RFC6570 specifications. For more information please visit the project GitHub page.

Example:

baasicMeteringCategoryRouteService.parse('<route>/{?embed,fields,options}').expand({embed: '<embedded-resource>'});

baasicMeteringCategoryRouteService.batch.create()

Parses create route; this URI template does not expose any additional options.

Example:

baasicMeteringCategoryRouteService.batch.create.expand({});              

baasicMeteringCategoryRouteService.batch.remove()

Parses remove route; this URI template does not expose any additional options.

Example:

baasicMeteringCategoryRouteService.batch.remove.expand({});              

baasicMeteringCategoryRouteService.batch.update()

Parses update route; this URI template does not expose any additional options.

Example:

baasicMeteringCategoryRouteService.batch.update.expand({});              

---

Notes:

• Refer to the REST API documentation for detailed information about available Baasic REST API end-points.
• URI Template syntax enables expanding the Baasic route templates to Baasic REST URIs providing it with an object that contains URI parameters.
• All end-point objects are transformed by the associated route service.

(c) 2017 Mono Ltd

Author: Mono Ltd

License: MIT