Skip to content

Eco club offering list

Description

Provides listing of eco club offering data for specified application and eco club offering.

GET https://impact.dots.eco/api/v1/eco-club-offering/list/{app_token}

Please check Headers and authorization.

Parameters

app_token - required*, string - The app token can be found in the app dashboard.

uuid - optional*_ - The uuid of the eco club offering.

external-unique-id - optional*_ - The external unique id 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": "229ca556-14e5-408f-8ed3-08eac72f8996",
        "title": null,
        "quantity": "6",
        "limit_allocations": "139",
        "name_on_certificate": null,
        "certificate_info": null,
        "activation_date": null,
        "activation_hour": null,
        "expiration_date": null,
        "expiration_hour": null,
        "code": "nulla aliquam",
        "send_email_on_activation_date": "no",
        "max_claims_total": 1,
        "max_claims_per_email": "Unlimited",
        "claim_url": "https://impact.dots.eco/app/123/eco-club/claim",
        "external_unique_id": null,
        "no_of_claims": 0
    },
    {
        "uuid": "12332e-123-4c06-1323-87f72184e720",
        "title": null,
        "quantity": "6",
        "limit_allocations": "139",
        "name_on_certificate": null,
        "certificate_info": null,
        "activation_date": null,
        "activation_hour": null,
        "expiration_date": null,
        "expiration_hour": null,
        "code": "doloremque",
        "send_email_on_activation_date": "no",
        "max_claims_total": 1,
        "max_claims_per_email": "Unlimited",
        "claim_url": "https://impact.dots.eco/app/123/eco-club/claim",
        "external_unique_id": null,
        "no_of_claims": 0
    },
    {
        "uuid": "1233eefd-aeb4-xcc-ab3b-dfeee",
        "title": null,
        "quantity": "6",
        "limit_allocations": "139",
        "name_on_certificate": null,
        "certificate_info": null,
        "activation_date": null,
        "activation_hour": null,
        "expiration_date": null,
        "expiration_hour": null,
        "code": "praesentium consectetur",
        "send_email_on_activation_date": "no",
        "max_claims_total": 1,
        "max_claims_per_email": "Unlimited",
        "claim_url": "https://impact.dots.eco/app/123/eco-club/claim",
        "external_unique_id": null,
        "no_of_claims": 0
    }
]

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