Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

TMY data generation process consists of 3 main steps:

  • Subscription registration and token generation – through User interface (see the above section)

  • Sending request for TMY data generation

    • In case of correct request, “requestId” is returned

    • In case of some issue, error code is returned

  • Sending request for TMY data generation status

    • In case of successful and finished processing, URL with generated data link is retrieved

    • In case of request processing, processing status information is returned

    • In case of any issue, error code is returned

 

There is one additional supporting endpoint exposed to supplement requestor with subscription details like user name (for case of using user tokens), company and assigned subscriptions. If the authorization token that was used for subscription details retrieving is bound to a user, subscriptions details to which the user is assigned are retrieved in the response message. Additionally, response contains also information about the user assigned to the token.

 

Combination of Technical parameters

Subscription type / Frequency (support)

PT60M

PT15M

Basic

YES

NO

Professional

YES

YES

Format type / Frequency

PT60M

PT15M

SOLARGIS (JSON/CSV)

YES

YES

SAM

YES

YES

HELIOSCOPE

YES

NO

TMY Subscription status description

TMY Subscription (displayed on the Company Subscription Overview page) can have one of following states:

  • Active

    • Consumption is enabled – parameter set on the subscription

    • Subscription can be used from date point of view (valid from <= now <= valid to)

    • Subscription has remaining calls that can be consumed

  • Inactive

    • Consumption is disabled – parameter set on the subscription

  • Expired

    • Consumption is enabled – parameter set on the subscription

    • Subscription is not valid from date point of view (valid to > now)

  • Consumed

    • Consumption is enabled – parameter set on the subscription

    • Subscription can be used from date point of view (valid from >= now <= valid to)

    • Subscription does not have any remaining calls that can be consumed

  • ToBeActive

    • Consumption is enabled – parameter set on the subscription

    • Subscription can be used in the future (valid from > now)

    • Subscription has remaining calls that can be consumed

 

List of HTTP error codes

Unauthorized

  • HTTP status code 401

  • Invalid authorization: missing authorization header, expired token, attempt to get data of someone else, …

Not found

  • HTTP status code 404

  • for example, request cannot be found based on the provided requestId

Bad request

  • HTTP status code 400

  • invalid request data

Server error

  • HTTP status code 500

  • unexpected server error

  • No labels