Library

Provides a global standard set of Water Quality Specific Parameters, Units, Quantity Types, Agencies, Analysis Methods, and the means to map different standards. In addition all library items are localized into 24 languages. Additional application localization support is also provided.

See Also: Global Library

Agency Methods

CreateAgencyAsync

Creates a new agency.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.CreateAgencyAsync(Agency agency)

Parameters: agency (Agency) – The Agency as an object.
Returns: Newly created Agency.
Return type: Task<Agency>

UpdateAgencyAsync

Updates an existing Agency.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.UpdateAgencyAsync(Agency agency)

Parameters: agency (Agency) – The Agency as an object.
Returns: Updated Agency.
Return type: Task<Agency>

GetAgencyAsync

Retrieves Parameter by unique Id (GUID).

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetAgencyAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the Agency.
Returns: An Agency.
Return type: Task<Agency>

GetAgenciesAsync

Retrieves all agencies.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetAgenciesAsync()

Returns: A list of all of the Agencies.
Return type: Task<List<Agency>>

Agency Parameter Code Type Methods

CreateParameterAgencyCodeTypeAsync

Creates a new parameterAgencyCodeType.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.CreateParameterAgencyCodeTypeAsync(ParameterAgencyCodeType parameterAgencyCodeType)

Parameters: parameterAgencyCodeType (ParameterAgencyCodeType) – The ParameterAgencyCodeType as an object.
Returns: Newly created ParameterAgencyCodeType.
Return type: Task<ParameterAgencyCodeType>

UpdateParameterAgencyCodeTypeAsync

Updates an existing ParameterAgencyCodeType.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.UpdateParameterAgencyCodeTypeAsync(ParameterAgencyCodeType parameterAgencyCodeType)

Parameters: parameterAgencyCodeType (ParameterAgencyCodeType) – The ParameterAgencyCodeType as an object.
Returns: Updated ParameterAgencyCodeType.
Return type: Task<ParameterAgencyCodeType>

DeleteParameterAgencyCodeTypeAsync

Deletes an existing ParameterAgencyCodeType.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.DeleteParameterAgencyCodeTypeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the ParameterAgencyCodeType.
Returns: Whether the ParameterAgencyCodeType was deleted.
Return type: Task<bool>

GetParameterAgencyCodeTypeAsync

Retrieves ParameterAgencyCodeType by unique Id (GUID).

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetParameterAgencyCodeTypeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the ParameterAgencyCodeType.
Returns: A ParameterAgencyCodeType.
Return type: Task<ParameterAgencyCodeType>

GetParameterAgencyCodeTypesAsync

Retrieves all ParameterAgencyCodeTypes.

`RESTful API Documentation <https://aqi-feature-api-mgmt.developer.azure-api.net/api-details#api=claros-common-library-v1&operation=parameteragencycodetype-get`_
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetParameterAgencyCodeTypesAsync()

Returns: A list of all of the ParameterAgencyCodeType.
Return type: Task<List<ParameterAgencyCodeType>>

Agency Parameter Code Methods

CreateParameterAgencyCodeAsync

Creates a new ParameterAgencyCode.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.CreateParameterAgencyCodeAsync(ParameterAgencyCode parameterAgencyCode)

Parameters: parameterAgencyCode (ParameterAgencyCode) – The ParameterAgencyCode as an object.
Returns: Newly created ParameterAgencyCode.
Return type: Task<ParameterAgencyCode>

UpdateParameterAgencyCodeAsync

Updates an existing ParameterAgencyCode.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.UpdateParameterAgencyCodeAsync(ParameterAgencyCode parameterAgencyCode)

Parameters: parameterAgencyCode (ParameterAgencyCode) – The ParameterAgencyCode as an object.
Returns: Updated ParameterAgencyCode.
Return type: Task<ParameterAgencyCode>

DeleteParameterAgencyCodeAsync

Deletes an existing ParameterAgencyCode.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.DeleteParameterAgencyCodeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the ParameterAgencyCode.
Returns: Whether the ParameterAgencyCode was deleted.
Return type: Task<bool>

GetParameterAgencyCodeAsync

Retrieves ParameterAgencyCode by unique Id (GUID).

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetParameterAgencyCodeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the ParameterAgencyCode.
Returns: A ParameterAgencyCode.
Return type: Task<ParameterAgencyCode>

GetParameterAgencyCodesAsync

Retrieves all ParameterAgencyCode.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetParameterAgencyCodesAsync(string parameterAgencyCodeTypeId = null)

Parameters: parameterAgencyCodeTypeId (string) – The parameterAgencyCodeTypeId (GUID).
Returns: A list of all of the ParameterAgencyCode.
Return type: Task<List<ParameterAgencyCode>>

Agency Unit Type Methods

CreateUnitAgencyCodeTypeAsync

Creates a new UnitAgencyCodeType.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.CreateUnitAgencyCodeTypeAsync(UnitAgencyCodeType unitAgencyCodeType)

Parameters: unitAgencyCodeType (UnitAgencyCodeType) – The UnitAgencyCodeType as an object.
Returns: Newly created UnitAgencyCodeType.
Return type: Task<UnitAgencyCodeType>

UpdateUnitAgencyCodeTypeAsync

Updates an existing UnitAgencyCodeType.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.UpdateUnitAgencyCodeTypeAsync(UnitAgencyCodeType unitAgencyCodeType)

Parameters: unitAgencyCodeType (UnitAgencyCodeType) – The UnitAgencyCodeType as an object.
Returns: Updated UnitAgencyCodeType.
Return type: Task<UnitAgencyCodeType>

DeleteUnitAgencyCodeTypeAsync

Deletes an existing UnitAgencyCodeType.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.DeleteUnitAgencyCodeTypeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the UnitAgencyCodeType.
Returns: Whether the UnitAgencyCodeType was deleted.
Return type: Task<bool>

GetUnitAgencyCodeTypeAsync

Retrieves ParameterAgencyCodeType by unique Id (GUID).

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetUnitAgencyCodeTypeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the ParameterAgencyCodeType.
Returns: A ParameterAgencyCodeType.
Return type: Task<ParameterAgencyCodeType>

GetUnitAgencyCodeTypesAsync

Retrieves all UnitAgencyCodeType.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetUnitAgencyCodeTypesAsync()

Returns: A list of all of the UnitAgencyCodeType.
Return type: Task<List<UnitAgencyCodeType>>

Agency Unit Code Methods

CreateUnitAgencyCodeAsync

Creates a new ParameterAgencyCode.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.CreateUnitAgencyCodeAsync(UnitAgencyCode unitAgencyCode)

Parameters: unitAgencyCode (UnitAgencyCode) – The UnitAgencyCode as an object.
Returns: Newly created UnitAgencyCode.
Return type: Task<UnitAgencyCode>

UpdateUnitAgencyCodeAsync

Updates an existing UnitAgencyCode.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.UpdateUnitAgencyCodeAsync(UnitAgencyCode unitAgencyCode)

Parameters: unitAgencyCode (UnitAgencyCode) – The UnitAgencyCode as an object.
Returns: Updated UnitAgencyCode.
Return type: Task<UnitAgencyCode>

DeleteUnitAgencyCodeAsync

Deletes an existing UnitAgencyCode.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.DeleteUnitAgencyCodeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the UnitAgencyCode.
Returns: Whether the UnitAgencyCode was deleted.
Return type: Task<bool>

GetUnitAgencyCodeAsync

Retrieves UnitAgencyCode by unique Id (GUID).

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetUnitAgencyCodeAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the UnitAgencyCode.
Returns: A UnitAgencyCode.
Return type: Task<UnitAgencyCode>

GetUnitAgencyCodesAsync

Retrieves all UnitAgencyCodes.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetUnitAgencyCodesAsync()

Returns: A list of all of the UnitAgencyCode.
Return type: Task<List<UnitAgencyCode>>

Parameter Methods

CreateParameterAsync

Creates a new parameter.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.CreateParameterAsync(Parameter parameter)

Parameters: parameter (Parameter) – The Parameter as an object.
Returns: Newly created Unit.
Return type: Task<Parameter>

UpdateParameterAsync

Updates an existing parameter.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.UpdateParameterAsync(Parameter parameter)

Parameters: parameter (Parameter) – The Parameter as an object.
Returns: Updated Parameter.
Return type: Task<Parameter>

DeleteParameterAsync

Deletes an existing parameter.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.DeleteParameterAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the Parameter.
Returns: Whether the Parameter was deleted.
Return type: Task<bool>

GetParameterAsync

Retrieves Parameter by unique integer Id.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetParameterAsync(int id)

Parameters: unitId (int) – The unique identifier (int) for the Parameter.
Returns: A Parameter.
Return type: Task<Parameter>

GetParametersAsync

Retrieves all parameters.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetParametersAsync()

Returns: A list of all of the Parameters.
Return type: Task<List<Parameter>>

Quantity Type Methods

GetQuantityTypesAsync

Retrieves all quantity types.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetQuantityTypesAsync()

Returns: A list of all of the QuantityTypes.
Return type: Task<List<QuantityType>>

Translation (i18n) Methods

GetMobilei18nKeysAsync

Retrieves translation keys needed for the mobile application.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetMobilei18nKeysAsync(string language)

Parameters: language (string) – The language culture code.
Returns: A list of all of the requested i18nKey objects needed for Mobile.
Return type: Task<List<I18NKey>>

Geti18nKeysAsync

Retrieves translation keys for a list of requested modules.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.Geti18nKeysAsync(string language, string modules)

Parameters

language (string) – The language culture code.
modules (string) – Comma delimited set of Modules of translations. Example: AQI_FOUNDATION_LIBRARY, AQI_MOBILE_RIO

Returns

A list of all of the requested i18nKey objects needed for Mobile.

Return type

Task<List<I18NKey>>

Unit Type Methods

CreateUnitAsync

Creates a new unit.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.CreateUnitAsync(Unit unit)

Parameters: unit (Unit) – The Unit as an object.
Returns: Newly created Unit.
Return type: Task<Unit>

UpdateUnitAsync

Updates an existing unit.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.UpdateUnitAsync(Unit unit)

Parameters: unit (Unit) – The Unit as an object.
Returns: Updated Unit.
Return type: Task<Unit>

DeleteUnitAsync

Deletes an existing unit.

RESTful API Documentation
Required Role(s): Super Admin
User must be authenticated

ClientSDK.Library.DeleteUnitAsync(string id)

Parameters: id (string) – The unique identifier (GUID) for the Unit.
Returns: Whether the unit was successfully deleted.
Return type: Task<bool>

GetUnitAsync

Retrieves Unit by unique integer Id.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetUnitAsync(int unitId)

Parameters: unitId (int) – The unique identifier (int) for the Unit.
Returns: Requested Unit.
Return type: Task<Unit>

GetUnitsAsync

Retrieves all units.

RESTful API Documentation
Required Role(s): Any
User must be authenticated

ClientSDK.Library.GetUnitsAsync()

Returns: A list of all of the Units.
Return type: Task<List<Unit>>