Donation ยท Donators
Get donator
Returns the donator with a given debtor account: the total, number, first and last date of all donations which are not revoked, the ten latest donations and the running recurring donations
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonation.read
Also checked, depending on the request and the records it touches
contract.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
accountintegerrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donators/YOUR_ACCOUNT' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donators/YOUR_ACCOUNT", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donators/YOUR_ACCOUNT', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
namestring -
accountnumber -
totalValuenumber -
donationCountintegerat least 0
-
firstDonationDatestring -
lastDonationDatestring -
donationsobject[]6 properties
-
donationid -
datestring -
valuenumber -
typestringcashmembershipFeeassetStockrefundnonCash -
campaignNamestringnullable -
confirmationStatusstringpendingnotRequiredcreatedthanked
-
-
recurringobject[]nullable4 properties
-
contractid -
planNamestring -
amountnumbernullable -
intervalstringmonthquarterhalfYearyearcustomflexible
-
Response200
{
"name": "string",
"account": 1,
"totalValue": 1,
"donationCount": 0,
"firstDonationDate": "string",
"lastDonationDate": "string",
"donations": [
{
"donation": "000000000000000000000001",
"date": "string",
"value": 1,
"type": "cash",
"campaignName": "string",
"confirmationStatus": "pending"
}
],
"recurring": [
{
"contract": "000000000000000000000001",
"planName": "string",
"amount": 1,
"interval": "month"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.