Get a list of certificates
Description
Displays a list of all certificates for a given app_token
and remote_user_id
GET
https://impact.dots.eco/api/v1/certificate/list/{app_token}/{remote_user_id}
Please check Headers and authorization.
Parameters
app_token
- required*, string
- Application ID and first part of application uuid stored in Dots.eco
remote_user_id
- required*, string
- Value of the User ID the certificate is issued to.
Example request
The minimal request that will work
curl --location --request GET 'https://impact.dots.eco/api/v1/certificate/list/APP_TOKEN/REMOTE_USER_ID' \
--header 'Content-Type: application/json' \
--header 'auth-token: YOUR_AUTH_TOKEN' \
--data-raw '{
}'
Key/Value pairs response body
"certificate_id": [string]
- ID of the certificate"external_unique_id": [string]
- External ID of that certificate"certificate_url": [string]
- Certificate Url"certificate_image_url": [string]
- Certificate Image Url"app_id": [integer]
- Application ID"app_name": [string]
- Name of Application"remote_user_id": [string]
- Remote User ID"name_on_certificate": [string]
- The Username printed on Certificate"certificate_design": [string]
- The Certificate Design"certificate_info": [string]
- The Certificate Info"impact_qty": [integer]
- Impact Quantity"impact_type_id": [integer]
- Impact Type ID"impact_type_name": [string]
- Name of the Impact Type"impact_status": [string]
- Status of Impact"created_timestamp": [string]
- Created Date Timestamp"allocation_id": [integer]
- Allocation ID"country": [string]
- Certificate Country"geolocation": [object]
- Certificate geolocation, can be a polygon represented by multiple points.
Example response
success
[
{
"certificate_id": "134410-6-5",
"certificate_url": "https://impact.dots.eco/certificate/c7cd3320-1f15-4127-a5e4-6935abcf5fc9",
"certificate_image_url": "https://impact.dots.eco/certificate/img/c7cd3320-1f15-4127-a5e4-6935abcf5fc9.jpg",
"app_id": "6",
"app_name": "Dots.eco",
"remote_user_id": "testuser",
"name_on_certificate": "John Doe",
"certificate_design": null,
"certificate_info": null,
"impact_qty": 1,
"impact_type_id": 185,
"impact_type_name": "Wildlife land",
"impact_status": null,
"created_timestamp": 1663080111,
"allocation_id": "8",
"country": "Grenada",
"geolocation": null
},
{
"certificate_id": "134411-6-5",
"certificate_url": "https://impact.dots.eco/certificate/1ca15b15-dec1-494b-884f-a9fefa953a67",
"certificate_image_url": "https://impact.dots.eco/certificate/img/1ca15b15-dec1-494b-884f-a9fefa953a67.jpg",
"app_id": "6",
"app_name": "Dots.eco",
"remote_user_id": "testuser",
"name_on_certificate": "John Doe",
"certificate_design": "silver",
"certificate_info": null,
"impact_qty": 1,
"impact_type_id": 196,
"impact_type_name": "Save a Sea Turtle",
"impact_status": null,
"created_timestamp": 1663080297,
"allocation_id": "14",
"country": "Ethiopia",
"geolocation": [
{
"lat": 7.2015830000000003,
"lng": 37.253971999999997
}
]
}
]
Possible error responses
Unprocessable Entity
{
"message": "The app_token is invalid."
}
Status: 422 Unprocessable Entity
Not Found
{
"message": "The given user doesn't exist."
}
Status: 404 Not Found Exception