Eco club offering list
Description
Provides the eco club offering data for specified application and eco club offering uuid.
GET
https://impact.dots.eco/api/v1/eco-club-offering/list/{app_token}/{uuid}
Please check Headers and authorization.
Parameters
app_token
- required*, string
- The app token can be found in the app dashboard.
uuid
- required* - The uuid of the eco club offering.
Example request
curl --location 'https://impact.dots.eco/api/v1/eco-club-offering/list/1-aa641a0f/3729666d-bfd8-4515-9560-de1d95be5353' \
--header 'Content-Type: application/json' \
--header 'auth-token: YOUR_AUTH_TOKEN' \
--data-raw '{
}'
Key/Value pairs response body
"uuid": [string]
: The uuid for the eco club offering entity."quantity": [integer]
- The impact quantity for the created offering."limit_allocations": [string]
- A comma separated values of the Allocations to set for this offering."name_on_certificate": [string]
- The name of the user that certificate is issued for."activation_date": [string]
- The activation date of this offering."activation_hour": [string]
- The activation hour in GMT time."expiration_date": [string]
- The expiration date of this offering,"expiration_hour": [string]
- The expiration hour in GMT time,"code": [string]
- The activation code for this offering."mail": [string]
- The user for this offering."title": [string]
- The title for the eco club offering entity."max_claims_total": [integer]
- The amount how many times offering can be claimed."max_claims_per_email": [string/integer]
- The amount how many times the same email can be used."send_email_on_activation_date": [string]
- The information if email will be sent on activation date."claim_url": [URL]
- URL to the claim form. Will return the claim URL according the requested language. Default is English."no_of_claims": [integer]
- The number of claims for this offering.
Example response
success
{
"uuid": "3729666d-bfd8-4515-9560-de1d95be5353",
"quantity": 10,
"limit_allocations": "32,31,14",
"name_on_certificate": "John Doe",
"activation_date": "2022-12-24",
"activation_hour": "01:00:00",
"expiration_date": "2022-12-31",
"expiration_hour": "01:00:00",
"code": "e-826254",
"mail": "test@test.com",
"title": "Test title",
"max_claims_total": 3,
"max_claims_per_email": "Unlimited",
"send_email_on_activation_date": "yes",
"remote_user_id": "remote_user_id_example",
"claim_url": "https://impact.dots.eco/app/1/eco-club/claim",
"no_of_claims": 2
}
Possible error responses
Access Denied
App Token is not provided
{
"message": "Please provide a app_token."
}
Status: 403 Forbidden
Invalid Application token provided
{
"message": "Please provide a valid app_token."
}
Status: 403 Forbidden
Wrong auth-token provided
{
"message": "Auth user not associated with the application."
}
Status: 403 Forbidden
Eco club is not enabled for the application
{
"message": "Provided app is not of type of Eco Club."
}
Status: 403 Forbidden
Company associated with the application is not active
{
"message": "Your company is not yet activated for production requests. Please contact your account manager at Dots.eco to activate it."
}
Status: 403 Forbidden
When uuid is not provided
{
"message": "Please provide a uuid."
}
Status: 403 Forbidden
Eco club offering is not available for provided uuid
{
"message": "Eco Club Offerings not found."
}
Status: 403 Forbidden