# Glow Platform ## Docs - [Welcome to Glow Data Service!](https://docs.glownetzero.com/welcome-to-glow-data-service-1613563m0.md): - [Getting Started](https://docs.glownetzero.com/getting-started-1647272m0.md): - [Glow Portals](https://docs.glownetzero.com/glow-portals-1644049m0.md): - [Introducing the Glow System](https://docs.glownetzero.com/introducing-the-glow-system-1644047m0.md): - [API Authentication](https://docs.glownetzero.com/api-authentication-1644050m0.md): - Smart Meter Onboarding [Introducing Smart Meter Onboarding](https://docs.glownetzero.com/introducing-smart-meter-onboarding-2288928m0.md): - Smart Meter Onboarding [Smart Meter Eligibility Check](https://docs.glownetzero.com/smart-meter-eligibility-check-2288867m0.md): - Smart Meter Onboarding [Terms and Conditions APIs and Management](https://docs.glownetzero.com/terms-and-conditions-apis-and-management-2288932m0.md): - Smart Meter Onboarding > Onboarding Methods — Direct Integration [EUI/Postcode Check](https://docs.glownetzero.com/euipostcode-check-2288927m0.md): - Smart Meter Onboarding > Onboarding Methods — Direct Integration [AVS Check](https://docs.glownetzero.com/avs-check-1723148m0.md): - Smart Meter Onboarding > Onboarding Methods — Hosted Integration > Glow IDV SDK [Introducing the Glow SDK](https://docs.glownetzero.com/introducing-the-glow-sdk-2258818m0.md): - Smart Meter Onboarding > Onboarding Methods — Hosted Integration > Glow IDV SDK [Supported Verification Methods ](https://docs.glownetzero.com/supported-verification-methods-2259701m0.md): - Smart Meter Onboarding > Onboarding Methods — Hosted Integration > Glow IDV SDK [Implementation Guide — Web](https://docs.glownetzero.com/implementation-guide-web-2246185m0.md): - Smart Meter Onboarding > Onboarding Methods — Hosted Integration > Glow IDV SDK [Implementation Guide — Mobile](https://docs.glownetzero.com/implementation-guide-mobile-2351890m0.md): - Smart Meter Onboarding > Onboarding Methods — Hosted Integration > Glow IDV SDK [Verifiable Credentials](https://docs.glownetzero.com/verifiable-credentials-2258820m0.md): - Smart Meter Onboarding > Onboarding Methods — Hosted Integration > Glow IDV SDK [Verification Result Screen](https://docs.glownetzero.com/verification-result-screen-2385722m0.md): - Smart Meter Onboarding > Onboarding Methods — Hosted Integration > Glow IDV SDK [Consent Capture & Onboarding](https://docs.glownetzero.com/consent-capture-onboarding-2258821m0.md): - Smart Meter Onboarding > Onboarding Methods — No Integration [Invitation Functionality](https://docs.glownetzero.com/invitation-functionality-1647497m0.md): - Smart Meter Onboarding > Onboarding Methods — No Integration [Agent Verification Portal](https://docs.glownetzero.com/agent-verification-portal-2080166m0.md): - Data Retrieval [Retrieving Time Series Data from Onboarded Users](https://docs.glownetzero.com/retrieving-time-series-data-from-onboarded-users-1614807m0.md): - Consent Management and Offboarding [Consent Management](https://docs.glownetzero.com/consent-management-2288937m0.md): - Consent Management and Offboarding [Offboarding](https://docs.glownetzero.com/offboarding-2288938m0.md): - Glow CADs & Fulfilment [Glow CAD Fulfilment](https://docs.glownetzero.com/glow-cad-fulfilment-1644093m0.md): ## API Docs - API Reference > Smart Meter Elgibility > eligibility > smets-ihd-cad [Check MPxN has CAD/PPMID](https://docs.glownetzero.com/check-mpxn-has-cadppmid-21741934e0.md): Check MPxN has CAD/PPMID. If the inventory has a CAD or IHD, the resident of the respective property can use the postcode EUI method to register their smart meter. - API Reference > Smart Meter Elgibility > eligibility > checksmetsihd > postcode [Match EUI IHD with postcode](https://docs.glownetzero.com/match-eui-ihd-with-postcode-21741936e0.md): Match EUI IHD with postcode - API Reference > Smart Meter Elgibility > eligibility > checksmetsihd [Match EUI IHD with MPxN](https://docs.glownetzero.com/match-eui-ihd-with-mpxn-21741935e0.md): Match EUI IHD with MPxN - API Reference > Smart Meter Elgibility > eligibility > checksmetsmpxn [Check MPXN is eligible in DCC.](https://docs.glownetzero.com/check-mpxn-is-eligible-in-dcc-21741937e0.md): Check MPXN is eligible in DCC. - API Reference > Content System > content > {contentId} [get a content object](https://docs.glownetzero.com/get-a-content-object-21742013e0.md): Returns a single object. - API Reference > Content System > content > {contentId} [Update an existing content object](https://docs.glownetzero.com/update-an-existing-content-object-21742014e0.md): Update an existing content object. The fields that can be updated are minimum version and data. We will merge the existing data filed with the latest one. This means that the data field does not get overwritten. - API Reference > Content System > content [Find all the content objects of an application](https://docs.glownetzero.com/find-all-the-content-objects-of-an-application-21742011e0.md): Returns a list of the content objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > content [Add a content object](https://docs.glownetzero.com/add-a-content-object-21742012e0.md): Add a content object. - API Reference > Content System > languagecontent > {languageContentId} [get a language content object by ID](https://docs.glownetzero.com/get-a-language-content-object-by-id-21742017e0.md): Returns a single language object. - API Reference > Content System > languagecontent > {languageContentId} [Update an existing language content object](https://docs.glownetzero.com/update-an-existing-language-content-object-21742018e0.md): Update an existing language content object. The fields that can be updated are minimum version and data. We will merge the existing data filed with the latest one. This means that the data field does not get overwritten. - API Reference > Content System > languagecontent [Find all the language content objects of an application](https://docs.glownetzero.com/find-all-the-language-content-objects-of-an-application-21742015e0.md): Returns a list of the language content objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > languagecontent [Add a language content object](https://docs.glownetzero.com/add-a-language-content-object-21742016e0.md): Add a language content object. - API Reference > Content System > termsconditions > {tcId} [get a terms and conditions object by ID](https://docs.glownetzero.com/get-a-terms-and-conditions-object-by-id-21742021e0.md): Returns a single language object. - API Reference > Content System > termsconditions > current [Find the terms and conditions that are in force.](https://docs.glownetzero.com/find-the-terms-and-conditions-that-are-in-force-21742022e0.md): Returns a list of the terms and conditions that are in force of an application. There are some query parameters that can be used to narrow down the list. It is noted that there can only be one current terms and conditions for each reference. - API Reference > Content System > termsconditions [Find all the terms and conditions of an application](https://docs.glownetzero.com/find-all-the-terms-and-conditions-of-an-application-21742019e0.md): Returns a list of the terms and conditions objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > termsconditions [Add terms and conditions](https://docs.glownetzero.com/add-terms-and-conditions-21742020e0.md): Add terms and conditions, or create a clone of a preexisting one. - API Reference > Content System > termsconditionsuser > {tcUserId} [get a specified terms and conditions user obj](https://docs.glownetzero.com/get-a-specified-terms-and-conditions-user-obj-21742025e0.md): Returns a single terms and conditions user obj. - API Reference > Content System > termsconditionsuser [Find all the responses to terms and conditions documents.](https://docs.glownetzero.com/find-all-the-responses-to-terms-and-conditions-documents-21742023e0.md): Find all the responses to terms and conditions documents. This API will return all the t&cs the user has responded to. With administrative credentials and depending the query parameters this API will return a list of documents of the responses to terms and conditions documents from various users. - API Reference > Content System > termsconditionsuser [Add a user's response to Terms & Conditions document](https://docs.glownetzero.com/add-a-users-response-to-terms-conditions-document-21742024e0.md): - API Reference > Content System > supportdetails > {supportDetailsId} [get a support details object](https://docs.glownetzero.com/get-a-support-details-object-21742028e0.md): Returns a single support details object. - API Reference > Content System > supportdetails [Find all the support detail objects of an application](https://docs.glownetzero.com/find-all-the-support-detail-objects-of-an-application-21742026e0.md): Returns a list of the support detail objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > supportdetails [Add a support details object](https://docs.glownetzero.com/add-a-support-details-object-21742027e0.md): Add a support details object. - API Reference > Content System > faq > {faqId} [get a FAQ object](https://docs.glownetzero.com/get-a-faq-object-21742031e0.md): Returns a single FAQs object. - API Reference > Content System > faq [Find all the FAQ objects of an application](https://docs.glownetzero.com/find-all-the-faq-objects-of-an-application-21742029e0.md): Returns a list of the support detail objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > faq [Add a faq object](https://docs.glownetzero.com/add-a-faq-object-21742030e0.md): Add a faq object. - API Reference > Content System > prompttype > {promptTypeId} [get a Prompt Type object](https://docs.glownetzero.com/get-a-prompt-type-object-21742034e0.md): Returns a single object. - API Reference > Content System > prompttype [Find all the prompt type objects of an application](https://docs.glownetzero.com/find-all-the-prompt-type-objects-of-an-application-21742032e0.md): Returns a list of the prompt type objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > prompttype [Add a Prompt Type object](https://docs.glownetzero.com/add-a-prompt-type-object-21742033e0.md): Add a Prompt Type object. - API Reference > Content System > prompt > {promptId} [get a Prompt object](https://docs.glownetzero.com/get-a-prompt-object-21742037e0.md): Returns a single object. - API Reference > Content System > prompt [Find all the prompt objects of an application](https://docs.glownetzero.com/find-all-the-prompt-objects-of-an-application-21742035e0.md): Returns a list of the prompt objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > prompt [Add a Prompt object](https://docs.glownetzero.com/add-a-prompt-object-21742036e0.md): Add a Prompt object. - API Reference > Content System > promptuser > {promptUserId} [get a Prompt User object](https://docs.glownetzero.com/get-a-prompt-user-object-21742040e0.md): Returns a single object. - API Reference > Content System > promptuser [Find all the prompt user objects of an application](https://docs.glownetzero.com/find-all-the-prompt-user-objects-of-an-application-21742038e0.md): Returns a list of the prompt objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > promptuser [Add a Prompt User object](https://docs.glownetzero.com/add-a-prompt-user-object-21742039e0.md): Add a Prompt User object. - API Reference > Content System > useraction > {userActionId} [get a User Action object](https://docs.glownetzero.com/get-a-user-action-object-21742043e0.md): Returns a single object. - API Reference > Content System > useraction [Find all the user action objects of an application](https://docs.glownetzero.com/find-all-the-user-action-objects-of-an-application-21742041e0.md): Returns a list of the user action objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > useraction [Add a User Action object](https://docs.glownetzero.com/add-a-user-action-object-21742042e0.md): Add a User Action object. - API Reference > Content System > useractiontype > {userActionTypeId} [get a User Action Type object](https://docs.glownetzero.com/get-a-user-action-type-object-21742046e0.md): Returns a single object. - API Reference > Content System > useractiontype [Find all the user action type objects of an application](https://docs.glownetzero.com/find-all-the-user-action-type-objects-of-an-application-21742044e0.md): Returns a list of the user action typ objects of an application. There are some query parameters that can be used to narrow down the list. - API Reference > Content System > useractiontype [Add a User Action Type object](https://docs.glownetzero.com/add-a-user-action-type-object-21742045e0.md): Add a User Action Type object. - API Reference > User System > register [User self registers](https://docs.glownetzero.com/user-self-registers-21740865e0.md): Create a User a directory account for username and password login using this action. More specifically this is a registration process which creates a user and adds an account to the given application id. Self-Registration process should use this action. This call requires no authentication. - API Reference > User System > account > {accountId} > status [Find the status of a specified account. If the account is using an external directory service, this call will confirm whether the user is authenticated against it. This call requires administrative application level credentials.](https://docs.glownetzero.com/find-the-status-of-a-specified-account-if-the-account-is-using-an-external-directory-service-this-call-will-confirm-whether-the-user-is-authenticated-against-it-this-call-requires-administrative-application-level-credentials-21740887e0.md): Returns the status an account. - API Reference > User System > account > {accountId} > mobileapptoken [Add mobile app token to a user](https://docs.glownetzero.com/add-mobile-app-token-to-a-user-21740888e0.md): Mobile app token can be added to the user, who will then be able to receive push notifications. - API Reference > User System > account > {accountId} > mobileapptoken [Remove a mobile app token to a user](https://docs.glownetzero.com/remove-a-mobile-app-token-to-a-user-21740889e0.md): Mobile app tokens can be removed from a user. - API Reference > User System > account > {accountId} [Find specific account of an application.](https://docs.glownetzero.com/find-specific-account-of-an-application-21740884e0.md): Returns an account. - API Reference > User System > account > {accountId} [Updates the account's metadata.](https://docs.glownetzero.com/updates-the-accounts-metadata-21740885e0.md): Updates the account s metadata. Elements that can be updated include name. This can be used in on an administrative level. - API Reference > User System > account > {accountId} [Delete account](https://docs.glownetzero.com/delete-account-21740886e0.md): Delete account - API Reference > User System > account > status [With a given JWT token a user can have their account status verfied. If their account is created under an external directory service, this call will establish whether a user's token to the external service is still valid.](https://docs.glownetzero.com/with-a-given-jwt-token-a-user-can-have-their-account-status-verfied-if-their-account-is-created-under-an-external-directory-service-this-call-will-establish-whether-a-users-token-to-the-external-service-is-still-valid-21740890e0.md): Returns the status an account. - API Reference > User System > account > email [Change a user's email](https://docs.glownetzero.com/change-a-users-email-21740891e0.md): A user can update their email - API Reference > User System > account > name [Change a user's name](https://docs.glownetzero.com/change-a-users-name-21740892e0.md): A user can update their name - API Reference > User System > account > changepassword [Change a user's password](https://docs.glownetzero.com/change-a-users-password-21740893e0.md): A user can change their passwrod. They would neeed to have knowledge of their previous password and provide it in the body. - API Reference > User System > account [Find all accounts of an application](https://docs.glownetzero.com/find-all-accounts-of-an-application-21740882e0.md): Returns all accounts that belong to an application. - API Reference > User System > account [Add an account to an existing user](https://docs.glownetzero.com/add-an-account-to-an-existing-user-21740883e0.md): This call should be used when a user is registered via on the Glow ecosystem. By providing the username of the user a directory account may be added to the application. - API Reference > User System > user > {userId} > username [Change a user's username](https://docs.glownetzero.com/change-a-users-username-21740870e0.md): API to update a user's username - API Reference > User System > user > {userId} [Find specific user that has an account in an application.](https://docs.glownetzero.com/find-specific-user-that-has-an-account-in-an-application-21740868e0.md): Returns a user. - API Reference > User System > user > {userId} [Delete specific user. This will delete all the accounts of a user. Please refer to delete account API. This API requires specific permissions.](https://docs.glownetzero.com/delete-specific-user-this-will-delete-all-the-accounts-of-a-user-please-refer-to-delete-account-api-this-api-requires-specific-permissions-21740869e0.md): Deletes a user. - API Reference > User System > user > verify [Generate a user verification token](https://docs.glownetzero.com/generate-a-user-verification-token-21740871e0.md): This call generates a 4 digit token and sends it via second channel of communication over to the user (at the moment the only second channel of communication supported is email). - API Reference > User System > user > verify [Verify a user verification token](https://docs.glownetzero.com/verify-a-user-verification-token-21740872e0.md): This call generates a 4 digit token and sends it via second channel of communication over to the user (at the moment the only second channel of communication supported is email). - API Reference > User System > user > resetpassword [Generate a token that can be used by user to reset their password.](https://docs.glownetzero.com/generate-a-token-that-can-be-used-by-user-to-reset-their-password-21740873e0.md): This call generates a 4 digit token and sends it via second channel of communication over to the user (at the moment the only second channel of communication supported is email). The user can then use this token to reset their password. - API Reference > User System > user > resetpassword [A user resets their password](https://docs.glownetzero.com/a-user-resets-their-password-21740874e0.md): This call generates a 4 digit token and sends it via second channel of communication over to the user (at the moment the only second channel of communication supported is email). - API Reference > User System > user > verification > status > mpxns > renewal [Renew consent for a number of meterpoints](https://docs.glownetzero.com/renew-consent-for-a-number-of-meterpoints-21740876e0.md): A user can renew their consent for a number of meterpoints. The consent can be extended to a maximum of 18 months (default). - API Reference > User System > user > verification > status > mpxns > revocation [Revoke consent for a number of meterpoints](https://docs.glownetzero.com/revoke-consent-for-a-number-of-meterpoints-21740877e0.md): A user can revoke their consent for a number of meterpoints. - API Reference > User System > user > verification > status > mpxn > {mpxn} > renewal [Get meter point consent renewals](https://docs.glownetzero.com/get-meter-point-consent-renewals-21740878e0.md): - API Reference > User System > user > verification > status > mpxn > {mpxn} > renewal [Renew meter point consent](https://docs.glownetzero.com/renew-meter-point-consent-21740879e0.md): A user can renew their consent to access a meter point's data. The consent can be extended to a maximum of 18 months (default). - API Reference > User System > user > verification > status > mpxn > {mpxn} > revocation [Get meter point consent revocations](https://docs.glownetzero.com/get-meter-point-consent-revocations-21740880e0.md): - API Reference > User System > user > verification > status > mpxn > {mpxn} > revocation [Revoke meter point consent](https://docs.glownetzero.com/revoke-meter-point-consent-21740881e0.md): A user can renew their consent to access a meter point's data. The consent can be extended to a maximum of 18 months (default). - API Reference > User System > user > verification > status [API to retrieve user's meter points' consent and verification](https://docs.glownetzero.com/api-to-retrieve-users-meter-points-consent-and-verification-21740875e0.md): API to retrieve user's meter points' consent and verification status - API Reference > User System > user [Find specific user that has an account in an application from the username.](https://docs.glownetzero.com/find-specific-user-that-has-an-account-in-an-application-from-the-username-21740866e0.md): Returns a user. - API Reference > User System > user [Create a user](https://docs.glownetzero.com/create-a-user-21740867e0.md): This call can be used by an application to create a user. No verification will be required - API Reference > User System > accountprofile > {profileName} [Find specific group of application](https://docs.glownetzero.com/find-specific-group-of-application-21740896e0.md): Returns an application's group. - API Reference > User System > accountprofile [Find all the profiles of an account](https://docs.glownetzero.com/find-all-the-profiles-of-an-account-21740894e0.md): Returns all the profileNames of profiles an account has saved. - API Reference > User System > accountprofile [Create an account profile under a given profileName.](https://docs.glownetzero.com/create-an-account-profile-under-a-given-profilename-21740895e0.md): Create an account profile under a given profileName. profileName is a required field. Please note that anything under the profileName will be overwritten. - API Reference > User System > accountsession [get the session of an account](https://docs.glownetzero.com/get-the-session-of-an-account-21740897e0.md): Returns the session of an account - API Reference > User System > accountsession [Update an account session.](https://docs.glownetzero.com/update-an-account-session-21740898e0.md): Update fields of an account session. The fields that are updated are completely overwritten if they exist. - API Reference > User System > auth > token > {tokenId} [Deletes a token, specified by its tokenId.](https://docs.glownetzero.com/deletes-a-token-specified-by-its-tokenid-21740902e0.md): This call enables an user to delete and token and revoke access. JWT as well as OAuth tokens can be deleted. - API Reference > User System > auth > token [Returns all the tokens that are active and valid for a specified user.](https://docs.glownetzero.com/returns-all-the-tokens-that-are-active-and-valid-for-a-specified-user-21740901e0.md): This call enables a customer to view all the tokens that have been generated and used for their accounts. This includes all the JWT and OAuth tokens. By enabling this a user can then manage and monitor the access to their accounts. - API Reference > User System > auth > newToken [Generate a new token for an account.](https://docs.glownetzero.com/generate-a-new-token-for-an-account-21740903e0.md): An account provides an old token and gets a new one generated. - API Reference > User System > auth > deleteToken [delete a token](https://docs.glownetzero.com/delete-a-token-21740904e0.md): Delete the token the account used to make this call. - API Reference > User System > auth > oauth > access [Exchange the Authorization Code for an Access Token.](https://docs.glownetzero.com/exchange-the-authorization-code-for-an-access-token-21740907e0.md): The user system supports an OAuth 2.0 Authorization Code Grant. This call generates an access and refresh token from an OAuth 2.0 Authorization Code Grant. This API can also be used to generate a new access token with a given refresh token. Instead of using the authorization code in the body of the request (code), use the refresh token (refresh_token). - API Reference > User System > auth > oauth [Check and validate an Oauth Access token.](https://docs.glownetzero.com/check-and-validate-an-oauth-access-token-21740905e0.md): The user system supports an OAuth 2.0 Authorization Code Grant. This call validates that a generated access key is valid. - API Reference > User System > auth > oauth [Authenticate a user and generate an OAuth 2.0 Authorization Code Grant.](https://docs.glownetzero.com/authenticate-a-user-and-generate-an-oauth-2-0-authorization-code-grant-21740906e0.md): The user system supports an OAuth 2.0 Authorization Code Grant. This call authenticates a user and generates an OAuth 2.0 Authorization Code Grant. - API Reference > User System > auth [Checks whether a user token is valid.](https://docs.glownetzero.com/checks-whether-a-user-token-is-valid-21740899e0.md): Checks whether a user token is valid. - API Reference > User System > auth [authenticate an account](https://docs.glownetzero.com/authenticate-an-account-21740900e0.md): Autheticates the user and generates a JWT token. - API Reference > Virtual Entity System > vesys > appstats [find statistics on the number of Virtual Entities per application](https://docs.glownetzero.com/find-statistics-on-the-number-of-virtual-entities-per-application-21741910e0.md): Returns a single statistics entity - API Reference > Virtual Entity System > virtualentity > {id} > resources [Find the resources of that belong to Virtual Entity with ID](https://docs.glownetzero.com/find-the-resources-of-that-belong-to-virtual-entity-with-id-21741906e0.md): Returns a single Virtual Entity with a resource list of the full resource docs - API Reference > Virtual Entity System > virtualentity > {id} > attribute [Find a Virtual Entity's metadata by ID](https://docs.glownetzero.com/find-a-virtual-entitys-metadata-by-id-21741907e0.md): Returns all the metadata of a Virtual Entity - API Reference > Virtual Entity System > virtualentity > {id} > attribute [Add/Update a Virtual Entity's metadata](https://docs.glownetzero.com/addupdate-a-virtual-entitys-metadata-21741908e0.md): Add/Update a Virtual Entity's metadata. Whichever fields are included in body of call, will be updated - API Reference > Virtual Entity System > virtualentity > {id} > attribute [delete metadata from the Virtual Entity](https://docs.glownetzero.com/delete-metadata-from-the-virtual-entity-21741909e0.md): Pieces of metadata provided in the body will be deleted from the Virtual Entityl - API Reference > Virtual Entity System > virtualentity > {id} [Find Virtual Entity by ID](https://docs.glownetzero.com/find-virtual-entity-by-id-21741903e0.md): Returns a single Virtual Entity - API Reference > Virtual Entity System > virtualentity > {id} [Update a Virtual Entity](https://docs.glownetzero.com/update-a-virtual-entity-21741904e0.md): Please note that only specific properties of the Virtual Entity can be updated. These includes the following: name, description, location, city, country, postalCodem geoCoordinates, openStreetMapsRef, timeZone. - API Reference > Virtual Entity System > virtualentity > {id} [Delete a Virtual Entity](https://docs.glownetzero.com/delete-a-virtual-entity-21741905e0.md): Delete a single Virtual Entity - API Reference > Virtual Entity System > virtualentity [Add a new Virtual Entity](https://docs.glownetzero.com/add-a-new-virtual-entity-21741901e0.md): create a new Virtual Entity - API Reference > Virtual Entity System > virtualentity [Find all Virtual Entities](https://docs.glownetzero.com/find-all-virtual-entities-21741902e0.md): Returns a list of Virtual Entities that belong to an application (and a user if applicable) - API Reference > Virtual Entity System > vetype > {id} > resources [Find all resources that belong to a user that satisfy the Resource Types in the Virtual Entity Type definition.](https://docs.glownetzero.com/find-all-resources-that-belong-to-a-user-that-satisfy-the-resource-types-in-the-virtual-entity-type-definition-21741900e0.md): Returns the resources of a user that could potentially be used to create a Virtual Entity of the specified Virtual Entity Type - API Reference > Virtual Entity System > vetype > {id} [Find Virtual Entity Type by ID](https://docs.glownetzero.com/find-virtual-entity-type-by-id-21741898e0.md): Returns a single Virtual Entity Type - API Reference > Virtual Entity System > vetype > {id} [Update a Virtual Entity Type](https://docs.glownetzero.com/update-a-virtual-entity-type-21741899e0.md): Update Virtual Entity Type. Please note that only specific properties of the Virtual Entity Type can be updated, such as the name and the description. - API Reference > Virtual Entity System > vetype [Add a new Virtual Entity Type](https://docs.glownetzero.com/add-a-new-virtual-entity-type-21741896e0.md): Create a new Virtual Entity Type - API Reference > Virtual Entity System > vetype [Find all Virtual Entity Types](https://docs.glownetzero.com/find-all-virtual-entity-types-21741897e0.md): Returns a list of the application's Virtual Entity Types. - API Reference > Webhook System > webhook > {webhookId} [Find webhook by ID](https://docs.glownetzero.com/find-webhook-by-id-21742097e0.md): Returns a single webhook - API Reference > Webhook System > webhook > error > {errorId} [Find a particular webhook error](https://docs.glownetzero.com/find-a-particular-webhook-error-21742099e0.md): Find a webhook that has failed. A webhook can fail because either the maximum number of retries has been reached, or we received a 4xx HTTP status code (except for 429 - too many requests.). - API Reference > Webhook System > webhook > error [Find all the webhooks that have failed](https://docs.glownetzero.com/find-all-the-webhooks-that-have-failed-21742098e0.md): Find all the webhooks that have failed. A webhook can fail because either the maximum number of retries has been reached, or we received a 4xx HTTP status code (except for 429 - too many requests.). - API Reference > Webhook System > webhook [Find all webhooks of an application (or user)](https://docs.glownetzero.com/find-all-webhooks-of-an-application-or-user-21742096e0.md): Returns a list of all the webhooks per application - API Reference > Resource System > resource > {id} > readings [Get resource readings](https://docs.glownetzero.com/get-resource-readings-21741919e0.md): Returns readings for a specific resource. The requester needs to have access to the Resource. - API Reference > Resource System > resource > {id} > current [Get the current resource reading.](https://docs.glownetzero.com/get-the-current-resource-reading-21741920e0.md): Returns the latest instantaneous reading of a resource. Please note this API may return different responses for different Resource Types. - API Reference > Resource System > resource > {id} > first-time [Get the UTC time of the first available reading](https://docs.glownetzero.com/get-the-utc-time-of-the-first-available-reading-21741921e0.md): Returns the time of the first available reading for a given resource. - API Reference > Resource System > resource > {id} > last-time [Get the UTC time of the most recent available reading](https://docs.glownetzero.com/get-the-utc-time-of-the-most-recent-available-reading-21741922e0.md): Returns the time of the most recent available reading for a given resource. - API Reference > Resource System > resource > {id} > meterread [Get the cumulative value reported on a metering device. (Not supported for all resource types).](https://docs.glownetzero.com/get-the-cumulative-value-reported-on-a-metering-device-not-supported-for-all-resource-types-21741923e0.md): This API reports the cumulative value reported on a metering device and is only applicable for a subset of resources. Please note, that for smart metering in the UK the only segment of users who can access this functionality are people who have a Glow IHD/CAD. - API Reference > Resource System > resource > {id} > tariff [Get the latest tariff that is being applied to a resource.](https://docs.glownetzero.com/get-the-latest-tariff-that-is-being-applied-to-a-resource-21741924e0.md): Returns the latest tariff that is being applied to a resource. This call is generally used for energy resources. - API Reference > Resource System > resource > {id} > tariff-list [Get the tariff history that is being applied to a cost resource.](https://docs.glownetzero.com/get-the-tariff-history-that-is-being-applied-to-a-cost-resource-21741925e0.md): Returns the tariff history that is being applied to a cost resource. The tariffs are sourced from various areas (CADs, metering devices, manual settings). The effective dates can be used to determined what the period of a particular tariff is. Please note the following 3 things.
  1. Fistly, the response is not sorted, we recommend it to be sorted by effective date.
  2. Secondly, there are multiple types of tariffs i.e. flat rate, time of use, block and and dynamic. The dynamic tariffs can change each half-hour and therefore, for the period that is affected we will return the code of the dynamic code. More information on the rates will need to be requested individually.
  3. Thirdly, for DCC compatible smart meters in the UK, please note that we cannot retrieve the tariff history before the time of registration. The tariff history will need to be set over the API by a user (this is a feature which will soon be available).
  4. - API Reference > Resource System > resource > {id} > catchup [Trigger a request to retrieve the latest available readings from the DCC.](https://docs.glownetzero.com/trigger-a-request-to-retrieve-the-latest-available-readings-from-the-dcc-21741926e0.md): Applicable to resources that are sourced from the DCC. This API will trigger an asynchronous request to get the latest consumption readings from the DCC up to the last complete half hour. The readings from the DCC are in half hour intervals. To utilise the functionality of this API you need only make this request once on the change of the half hour (preferably with a random delay of up to 2 minutes). - API Reference > Resource System > resource > {id} > glowbinary [API that returns the resource's raw data in the Glow Binary format.](https://docs.glownetzero.com/api-that-returns-the-resources-raw-data-in-the-glow-binary-format-21741927e0.md): Not all resource types support this format. The return is not in JSON. Please use the available open source SDK libraries to process the binary format. - API Reference > Resource System > resource > {id} [Find resource by ID](https://docs.glownetzero.com/find-resource-by-id-21741918e0.md): Returns a single resource - API Reference > Resource System > resource > count [Count the number of resources per resourceType](https://docs.glownetzero.com/count-the-number-of-resources-per-resourcetype-21741928e0.md): Returns an array of the resource count and resourceId list per resourceTypeId - API Reference > Resource System > resource [Add a new resource](https://docs.glownetzero.com/add-a-new-resource-21741916e0.md): create a new resource - API Reference > Resource System > resource [Find all resources per user or application](https://docs.glownetzero.com/find-all-resources-per-user-or-application-21741917e0.md): returns a list of resources that belong to an application or a user - API Reference > Resource System > resourcetype > {id} > resource [Find resources of a specific resource type that belong to a user](https://docs.glownetzero.com/find-resources-of-a-specific-resource-type-that-belong-to-a-user-21741914e0.md): Returns a list of resources - API Reference > Resource System > resourcetype > {id} > appresource [Find resources of a specific resource type that an application has access to](https://docs.glownetzero.com/find-resources-of-a-specific-resource-type-that-an-application-has-access-to-21741915e0.md): Returns a list of resources - API Reference > Resource System > resourcetype > {id} [Find resourceType by ID](https://docs.glownetzero.com/find-resourcetype-by-id-21741913e0.md): Returns a single resourceType - API Reference > Resource System > resourcetype [Add a new resource type.](https://docs.glownetzero.com/add-a-new-resource-type-21741911e0.md): create a new resourceType - API Reference > Resource System > resourcetype [Find all resource types](https://docs.glownetzero.com/find-all-resource-types-21741912e0.md): returns a list of resource types - API Reference > Notification System > alerttype > {alertTypeId} [Find alert type by ID](https://docs.glownetzero.com/find-alert-type-by-id-21741989e0.md): Returns a single alert type - API Reference > Notification System > alerttype > {alertTypeId} [Updates the alert type's metadata.](https://docs.glownetzero.com/updates-the-alert-types-metadata-21741990e0.md): - API Reference > Notification System > alerttype [Find all alert types of an application](https://docs.glownetzero.com/find-all-alert-types-of-an-application-21741987e0.md): Returns all alert types, created by an application - API Reference > Notification System > alerttype [Create an alert type](https://docs.glownetzero.com/create-an-alert-type-21741988e0.md): Create an alert type - API Reference > Notification System > alert > {alertId} [Get an alert by Id](https://docs.glownetzero.com/get-an-alert-by-id-21741992e0.md): Get an alert by Id - API Reference > Notification System > alert > user [Get the alerts sent to a user](https://docs.glownetzero.com/get-the-alerts-sent-to-a-user-21741993e0.md): Get the alerts sent to a user - API Reference > Notification System > alert [Send an alert](https://docs.glownetzero.com/send-an-alert-21741991e0.md): Send an alert to a user - API Reference > Notification System > template > {templateId} [Find template type by ID](https://docs.glownetzero.com/find-template-type-by-id-21741996e0.md): Returns a single template of an application - API Reference > Notification System > template > {templateId} [Updates the teplate's metadata.](https://docs.glownetzero.com/updates-the-teplates-metadata-21741997e0.md): - API Reference > Notification System > template > {alertTypeId} > {channelType} > {cultureCode} [Find template by alertTypeId, channeType and cultureCode](https://docs.glownetzero.com/find-template-by-alerttypeid-channetype-and-culturecode-21741998e0.md): Returns a single template of an application. - API Reference > Notification System > template > {alertTypeId} > {channelType} > {cultureCode} [Create template by alertTypeId, channeType and cultureCode](https://docs.glownetzero.com/create-template-by-alerttypeid-channetype-and-culturecode-21741999e0.md): Create template by alertTypeId, channeType and cultureCode - API Reference > Notification System > template [Find all templates of an application](https://docs.glownetzero.com/find-all-templates-of-an-application-21741994e0.md): Returns all templates that belong to an application. - API Reference > Notification System > template [Create a template](https://docs.glownetzero.com/create-a-template-21741995e0.md): Create a template - API Reference > Notification System > notification > {notificationId} > log [Get the logs of a particular notification](https://docs.glownetzero.com/get-the-logs-of-a-particular-notification-21742001e0.md): Get the logs of a particular notification - API Reference > Notification System > notification > {notificationId} [Get a notification by Id](https://docs.glownetzero.com/get-a-notification-by-id-21742000e0.md): Get a notification by Id - API Reference > DFS > dfs > termsconditions [The current version of terms and conditions that is pertinent to DFS for a particular application.](https://docs.glownetzero.com/the-current-version-of-terms-and-conditions-that-is-pertinent-to-dfs-for-a-particular-application-21742002e0.md): The current version of terms and conditions that is pertinent to DFS for a particular application. The reference of the T&Cs is fixed to *DfsTermsConditions*. - API Reference > DFS > dfs > user [Get all the users that have opted in the DFS functionality](https://docs.glownetzero.com/get-all-the-users-that-have-opted-in-the-dfs-functionality-21742003e0.md): - API Reference > DFS > dfs > user [User opts in to DFS functionality for a particular MPxN. The mpxn field is only required if a user has more than one MPxN.](https://docs.glownetzero.com/user-opts-in-to-dfs-functionality-for-a-particular-mpxn-the-mpxn-field-is-only-required-if-a-user-has-more-than-one-mpxn-21742004e0.md): - API Reference > DFS > dfs > user [User opts out of DFS functionality](https://docs.glownetzero.com/user-opts-out-of-dfs-functionality-21742005e0.md): - API Reference > DFS > dfs > event > {dfsEventId} > user [Get all the users that have participated in a particular DFS event](https://docs.glownetzero.com/get-all-the-users-that-have-participated-in-a-particular-dfs-event-21742006e0.md): - API Reference > DFS > dfs > event > user > participation [API to indicate User participating in particular DFS event](https://docs.glownetzero.com/api-to-indicate-user-participating-in-particular-dfs-event-21742008e0.md): - API Reference > DFS > dfs > event > user [Get all the events a user has signed up for](https://docs.glownetzero.com/get-all-the-events-a-user-has-signed-up-for-21742007e0.md): - API Reference > Device Management System > devicetype > {id} [Find Device Type by ID](https://docs.glownetzero.com/find-device-type-by-id-21742052e0.md): Returns a single Device Type - API Reference > Device Management System > devicetype [Add a new Device Type](https://docs.glownetzero.com/add-a-new-device-type-21742050e0.md): create a new Device Type - API Reference > Device Management System > devicetype [Find all device types](https://docs.glownetzero.com/find-all-device-types-21742051e0.md): returns a list of devicetypes - API Reference > Device Management System > device > {id} > status [This call can be used to see whether a gateway device is sending packets to the Glow Platform (i.e. via WiFi).](https://docs.glownetzero.com/this-call-can-be-used-to-see-whether-a-gateway-device-is-sending-packets-to-the-glow-platform-i-e-via-wifi-21742056e0.md): - API Reference > Device Management System > device > {id} [Find device by ID](https://docs.glownetzero.com/find-device-by-id-21742055e0.md): Returns a single device - API Reference > Device Management System > device > resource > {resourceId} [Find the device that sources a specified resource.](https://docs.glownetzero.com/find-the-device-that-sources-a-specified-resource-21742057e0.md): Returns a Device, that sources a specified resource. - API Reference > Device Management System > device > meter-point > {meterPointNumber} > inventory [Get the DCC inventory of a meter point](https://docs.glownetzero.com/get-the-dcc-inventory-of-a-meter-point-21742058e0.md): Returns the DCC inventory - API Reference > Device Management System > device > meter-point > {meterPointNumber} > resources [Get the resources associated to a meter point](https://docs.glownetzero.com/get-the-resources-associated-to-a-meter-point-21742059e0.md): Returns the resources that are associated to a meter point - API Reference > Device Management System > device > smart-meter > {eui} > inventory [Get the DCC inventory of a meter point by providing an EUI.](https://docs.glownetzero.com/get-the-dcc-inventory-of-a-meter-point-by-providing-an-eui-21742060e0.md): Returns the DCC inventory - API Reference > Device Management System > device > status [This call can be used to see whether a gateway device is sending packets to the Glow Platform (i.e. via WiFi).](https://docs.glownetzero.com/this-call-can-be-used-to-see-whether-a-gateway-device-is-sending-packets-to-the-glow-platform-i-e-via-wifi-21742061e0.md): - API Reference > Device Management System > device [Get a user's devices](https://docs.glownetzero.com/get-a-users-devices-21742053e0.md): Returns an array of the devices that belong to a user. - API Reference > Device Management System > device [Add a new device](https://docs.glownetzero.com/add-a-new-device-21742054e0.md): create a new device - API Reference > Device Management System > discover > {hardwareId} [Find device by ID](https://docs.glownetzero.com/find-device-by-id-21742062e0.md): Returns the devices and if they do not exist the assets and product types