Darujme API

URL prefix

https://www.darujme.cz/api/{version} {?apiId,apiSecret}


Parameters

name type example description
version inlined in path
const["v1"]
apiId
string
apiSecret
string

Pledges #

#

Parameters

name type example description
organizationId inlined in path
string(^\d+\z)
2

ID organizace

pledgeId inlined in path
string(^\d+\z)
1203450

ID příslibu

Body

{ pledge: { pledgeId: 1203450 int

ID příslibu

organizationId: 2 int

ID neziskové organizace

projectId: 4563 int

ID projektu

promotionId: null null|int

ID výzvy

paymentMethod: "gp_webpay_charge" enum["proxypay_charge", "gp_webpay_charge", "funds_transfer", "payu_transfer"] isRecurrent: true bool

opakovaná platba?

pledgedAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

přislíbená částka

pledgedAt: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas příslibu

donor: { firstName: "Jan" string

křestní jméno dárce

lastName: "Novák" string

příjmení dárce

email: "jan.novak@seznam.cz" string(~^.+@.+$~)

e-mailová adresa

address: { street: "Otakarova 34" string

ulice

city: "Praha" string

město

postCode: "120 00" string

PSČ

country: "ČR" string

země

}
phone: "+420 123 456 789" string

telefonní číslo dárce

}
wantDonationCertificate: true bool

požaduje dárce potvrzení o daru?

customFields: { .+: null|string|int|float|bool }

hodnoty vlastních políček definovaných v administraci projektu

?lastTransactionExpectedOn: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas očekávané poslední platby. u jednorázové platby tato položka neexistuje, u opakované může nabývat null hodnoty

transactions: [ { transactionId: int

ID transakce

presentableCode: string

Označení transakce, které se zobrazuje v administraci jako VS. Tento kód nemusí být unikátní, proto je transactionId preferované

state: enum["pending", "pending_confirmation", "pending_update", "success", "success_money_on_account", "sent_to_organization", "failure", "error", "refund", "timeout", "canceled"] sentAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná dárcem

receivedAt: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas přijetí daru

outgoingAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná neziskovce

outgoingVs: null|string

VS symbol platby odeslané neziskovce

outgoingBankAccount: null|string

bankovní účet, na který byl neziskovce dar poslán

}
0…∞
]

transakce

}
}
#

Parameters

name type example description
organizationId inlined in path
string(^\d+\z)
2

ID organizace

pledgeId inlined in path
string(^\d+\z)
1203450

ID příslibu

Body

{ customFields: { .+: null|string|int|float|bool }

hodnoty vlastních políček definovaných v administraci projektu

}

Body

{ pledge: { pledgeId: 1203450 int

ID příslibu

organizationId: 2 int

ID neziskové organizace

projectId: 4563 int

ID projektu

promotionId: null null|int

ID výzvy

paymentMethod: "gp_webpay_charge" enum["proxypay_charge", "gp_webpay_charge", "funds_transfer", "payu_transfer"] isRecurrent: true bool

opakovaná platba?

pledgedAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

přislíbená částka

pledgedAt: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas příslibu

donor: { firstName: "Jan" string

křestní jméno dárce

lastName: "Novák" string

příjmení dárce

email: "jan.novak@seznam.cz" string(~^.+@.+$~)

e-mailová adresa

address: { street: "Otakarova 34" string

ulice

city: "Praha" string

město

postCode: "120 00" string

PSČ

country: "ČR" string

země

}
phone: "+420 123 456 789" string

telefonní číslo dárce

}
wantDonationCertificate: true bool

požaduje dárce potvrzení o daru?

customFields: { .+: null|string|int|float|bool }

hodnoty vlastních políček definovaných v administraci projektu

?lastTransactionExpectedOn: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas očekávané poslední platby. u jednorázové platby tato položka neexistuje, u opakované může nabývat null hodnoty

transactions: [ { transactionId: int

ID transakce

presentableCode: string

Označení transakce, které se zobrazuje v administraci jako VS. Tento kód nemusí být unikátní, proto je transactionId preferované

state: enum["pending", "pending_confirmation", "pending_update", "success", "success_money_on_account", "sent_to_organization", "failure", "error", "refund", "timeout", "canceled"] sentAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná dárcem

receivedAt: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas přijetí daru

outgoingAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná neziskovce

outgoingVs: null|string

VS symbol platby odeslané neziskovce

outgoingBankAccount: null|string

bankovní účet, na který byl neziskovce dar poslán

}
0…∞
]

transakce

}
}
#

Parameters

name type example description
organizationId inlined in path
string(^\d+\z)
2

ID organizace

fromPledgedDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-01"

>= datum příslibu

toPledgedDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-14"

<= datum příslibu

fromReceivedDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-01"

>= datum přijetí daru

toReceivedDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-14"

<= datum přijetí daru

fromOutgoingDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-01"

>= datum odeslání daru neziskovce

toOutgoingDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-14"

<= datum odeslání daru neziskovce

projectId optional
string(^\d+\z)
1200723

ID projektu

Body

{ pledges: [ { pledgeId: 1203450 int

ID příslibu

organizationId: 2 int

ID neziskové organizace

projectId: 4563 int

ID projektu

promotionId: null null|int

ID výzvy

paymentMethod: "gp_webpay_charge" enum["proxypay_charge", "gp_webpay_charge", "funds_transfer", "payu_transfer"] isRecurrent: true bool

opakovaná platba?

pledgedAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

přislíbená částka

pledgedAt: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas příslibu

donor: { firstName: "Jan" string

křestní jméno dárce

lastName: "Novák" string

příjmení dárce

email: "jan.novak@seznam.cz" string(~^.+@.+$~)

e-mailová adresa

address: { street: "Otakarova 34" string

ulice

city: "Praha" string

město

postCode: "120 00" string

PSČ

country: "ČR" string

země

}
phone: "+420 123 456 789" string

telefonní číslo dárce

}
wantDonationCertificate: true bool

požaduje dárce potvrzení o daru?

customFields: { .+: null|string|int|float|bool }

hodnoty vlastních políček definovaných v administraci projektu

?lastTransactionExpectedOn: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas očekávané poslední platby. u jednorázové platby tato položka neexistuje, u opakované může nabývat null hodnoty

transactions: [ { transactionId: int

ID transakce

presentableCode: string

Označení transakce, které se zobrazuje v administraci jako VS. Tento kód nemusí být unikátní, proto je transactionId preferované

state: enum["pending", "pending_confirmation", "pending_update", "success", "success_money_on_account", "sent_to_organization", "failure", "error", "refund", "timeout", "canceled"] sentAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná dárcem

receivedAt: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas přijetí daru

outgoingAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná neziskovce

outgoingVs: null|string

VS symbol platby odeslané neziskovce

outgoingBankAccount: null|string

bankovní účet, na který byl neziskovce dar poslán

}
0…∞
]

transakce

}
0…∞
]
}
#

Parameters

name type example description
organizationId inlined in path
string(^\d+\z)
2

ID organizace

vs inlined in path
string
2

variabilní symbol daru

Body

{ pledges: [ { pledgeId: 1203450 int

ID příslibu

organizationId: 2 int

ID neziskové organizace

projectId: 4563 int

ID projektu

promotionId: null null|int

ID výzvy

paymentMethod: "gp_webpay_charge" enum["proxypay_charge", "gp_webpay_charge", "funds_transfer", "payu_transfer"] isRecurrent: true bool

opakovaná platba?

pledgedAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

přislíbená částka

pledgedAt: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas příslibu

donor: { firstName: "Jan" string

křestní jméno dárce

lastName: "Novák" string

příjmení dárce

email: "jan.novak@seznam.cz" string(~^.+@.+$~)

e-mailová adresa

address: { street: "Otakarova 34" string

ulice

city: "Praha" string

město

postCode: "120 00" string

PSČ

country: "ČR" string

země

}
phone: "+420 123 456 789" string

telefonní číslo dárce

}
wantDonationCertificate: true bool

požaduje dárce potvrzení o daru?

customFields: { .+: null|string|int|float|bool }

hodnoty vlastních políček definovaných v administraci projektu

?lastTransactionExpectedOn: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas očekávané poslední platby. u jednorázové platby tato položka neexistuje, u opakované může nabývat null hodnoty

transactions: [ { transactionId: int

ID transakce

presentableCode: string

Označení transakce, které se zobrazuje v administraci jako VS. Tento kód nemusí být unikátní, proto je transactionId preferované

state: enum["pending", "pending_confirmation", "pending_update", "success", "success_money_on_account", "sent_to_organization", "failure", "error", "refund", "timeout", "canceled"] sentAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná dárcem

receivedAt: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas přijetí daru

outgoingAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná neziskovce

outgoingVs: null|string

VS symbol platby odeslané neziskovce

outgoingBankAccount: null|string

bankovní účet, na který byl neziskovce dar poslán

}
0…∞
]

transakce

}
0…∞
]
}

Transactions #

#

Parameters

name type example description
organizationId inlined in path
string(^\d+\z)
2

ID organizace

transactionId inlined in path
string(^\d+\z)
1203450

ID transakce

Body

{ transaction: { transactionId: int

ID transakce

presentableCode: string

Označení transakce, které se zobrazuje v administraci jako VS. Tento kód nemusí být unikátní, proto je transactionId preferované

state: enum["pending", "pending_confirmation", "pending_update", "success", "success_money_on_account", "sent_to_organization", "failure", "error", "refund", "timeout", "canceled"] sentAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná dárcem

receivedAt: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas přijetí daru

outgoingAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná neziskovce

outgoingVs: null|string

VS symbol platby odeslané neziskovce

outgoingBankAccount: null|string

bankovní účet, na který byl neziskovce dar poslán

pledge: { pledgeId: 1203450 int

ID příslibu

organizationId: 2 int

ID neziskové organizace

projectId: 4563 int

ID projektu

promotionId: null null|int

ID výzvy

paymentMethod: "gp_webpay_charge" enum["proxypay_charge", "gp_webpay_charge", "funds_transfer", "payu_transfer"] isRecurrent: true bool

opakovaná platba?

pledgedAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

přislíbená částka

pledgedAt: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas příslibu

donor: { firstName: "Jan" string

křestní jméno dárce

lastName: "Novák" string

příjmení dárce

email: "jan.novak@seznam.cz" string(~^.+@.+$~)

e-mailová adresa

address: { street: "Otakarova 34" string

ulice

city: "Praha" string

město

postCode: "120 00" string

PSČ

country: "ČR" string

země

}
phone: "+420 123 456 789" string

telefonní číslo dárce

}
wantDonationCertificate: true bool

požaduje dárce potvrzení o daru?

customFields: { .+: null|string|int|float|bool }

hodnoty vlastních políček definovaných v administraci projektu

?lastTransactionExpectedOn: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas očekávané poslední platby. u jednorázové platby tato položka neexistuje, u opakované může nabývat null hodnoty

}

příslib

}
}
#

Parameters

name type example description
organizationId inlined in path
string(^\d+\z)
2

ID organizace

projectIds[] optional
string(^\d+\z)

ID projektů

promotionIds[] optional
string(^\d+\z)

ID P2P kampaní

fromReceivedDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-01"

>= datum přijetí daru

toReceivedDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-14"

<= datum přijetí daru

fromOutgoingDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-01"

>= datum odeslání daru neziskovce

toOutgoingDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2016-09-14"

<= datum odeslání daru neziskovce

Body

{ transactions: [ { transactionId: int

ID transakce

presentableCode: string

Označení transakce, které se zobrazuje v administraci jako VS. Tento kód nemusí být unikátní, proto je transactionId preferované

state: enum["pending", "pending_confirmation", "pending_update", "success", "success_money_on_account", "sent_to_organization", "failure", "error", "refund", "timeout", "canceled"] sentAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná dárcem

receivedAt: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas přijetí daru

outgoingAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

částka odeslaná neziskovce

outgoingVs: null|string

VS symbol platby odeslané neziskovce

outgoingBankAccount: null|string

bankovní účet, na který byl neziskovce dar poslán

pledge: { pledgeId: 1203450 int

ID příslibu

organizationId: 2 int

ID neziskové organizace

projectId: 4563 int

ID projektu

promotionId: null null|int

ID výzvy

paymentMethod: "gp_webpay_charge" enum["proxypay_charge", "gp_webpay_charge", "funds_transfer", "payu_transfer"] isRecurrent: true bool

opakovaná platba?

pledgedAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

přislíbená částka

pledgedAt: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas příslibu

donor: { firstName: "Jan" string

křestní jméno dárce

lastName: "Novák" string

příjmení dárce

email: "jan.novak@seznam.cz" string(~^.+@.+$~)

e-mailová adresa

address: { street: "Otakarova 34" string

ulice

city: "Praha" string

město

postCode: "120 00" string

PSČ

country: "ČR" string

země

}
phone: "+420 123 456 789" string

telefonní číslo dárce

}
wantDonationCertificate: true bool

požaduje dárce potvrzení o daru?

customFields: { .+: null|string|int|float|bool }

hodnoty vlastních políček definovaných v administraci projektu

?lastTransactionExpectedOn: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum a čas očekávané poslední platby. u jednorázové platby tato položka neexistuje, u opakované může nabývat null hodnoty

}

příslib

}
0…∞
]
}

Projects & P2P #

#

Parameters

name type example description
projectId inlined in path
string(^\d+\z)
4563

ID projektu

Body

{ project: { projectId: int

ID projektu

promotionId: null

vždycky null

organization: { organizationId: int

ID organizace

name: string

název organizace

logo: null|{ url: string }

logo organizace

}
collectedAmountEstimate: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

odhad vybrané částky (zahrnuje i peníze, které jsou přislíbené, ale ještě nedorazily + matching)

donorsCount: int

odhad počtu dárců (zahrnuje i dárce, kteří přislíbily dar, ale jejichž peníze ještě nedorazily)

title: { ?cs: string ?en: string }

vícejazyčný název projektu

synopsis: { ?cs: string ?en: string }

vícejazyčný krátký popis projektu

content: { ?cs: string ?en: string }

vícejazyčný dlouhý text o projektu (HTML formát)

targetAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

cílová částka

activeUntil: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum konce projektu

imageHeader: null|{ url: string }

velký obrázek v hlavičce

donateUrl: string

URL vedoucí na darovací formulář

tags: [ { tagId: int

ID kategorie

label: { ?cs: string ?en: string }

název kategorie

}
0…∞
]

kategorie

donationMatching: anyOf null anyOf { fixedDonation: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

fixní částka pro matching

mustCollectAtLeast: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

}
{ donationPerOne: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka

mustCollectAtLeast: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

upperBound: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

maximální matching

}
suggestedAmounts: [ { primaryAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka v CZK

?secondaryAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["EUR"]
}

částka v EUR

description: { ?cs: string ?en: string }

vícejazyční popis částky

?default: bool

jedná se o defaltně vybranou částku?

}
0…∞
]

částky ve formuláři

}
}
#

Parameters

name type example description
projectId inlined in path
string(^\d+\z)
4563

ID projektu

fromDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2017-10-01"

Od data

toDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2017-10-30"

Do data

Body

{ projectStats: { projectId: int collectedAmountEstimate: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}
donorsCount: int
}
}
#

Parameters

name type example description
projectId inlined in path
string(^\d+\z)
4563

ID projektu

Body

{ promotions: [ { projectId: int

ID projektu

promotionId: int

ID výzvy

organization: { organizationId: int

ID organizace

name: string

název organizace

logo: null|{ url: string }

logo organizace

}
collectedAmountEstimate: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

odhad vybrané částky (zahrnuje i peníze, které jsou přislíbené, ale ještě nedorazily + matching)

donorsCount: int

odhad počtu dárců (zahrnuje i dárce, kteří přislíbily dar, ale jejichž peníze ještě nedorazily)

title: { ?cs: string ?en: string }

vícejazyčný název výzvy

synopsis: { ?cs: string ?en: string }

vícejazyčný krátký popis výzvy

content: { ?cs: string ?en: string }

vícejazyčný dlouhý text o výzvě (HTML formát)

targetAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

cílová částka

activeUntil: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum konce výzvy

imageHeader: null|{ url: string }

velký obrázek v hlavičce

donateUrl: string

URL vedoucí na darovací formulář

tags: [ { tagId: int

ID kategorie

label: { ?cs: string ?en: string }

název kategorie

}
0…∞
]

kategorie

video: null|{ url: string }

URL youtube videa

image: null|{ url: string }

obrázek

templateId: null|int

ID grafiky výzvy dle číselníku

donationMatching: anyOf null anyOf { fixedDonation: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

fixní částka pro matching

mustCollectAtLeast: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

}
{ donationPerOne: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka

mustCollectAtLeast: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

upperBound: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

maximální matching

}
suggestedAmounts: [ { primaryAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka v CZK

?secondaryAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["EUR"]
}

částka v EUR

description: { ?cs: string ?en: string }

vícejazyční popis částky

?default: bool

jedná se o defaltně vybranou částku?

}
0…∞
]

částky ve formuláři

}
0…∞
]

výzvy

}
#

Parameters

name type example description
promotionId inlined in path
string(^\d+\z)

ID výzvy

Body

{ promotion: { projectId: int

ID projektu

promotionId: int

ID výzvy

organization: { organizationId: int

ID organizace

name: string

název organizace

logo: null|{ url: string }

logo organizace

}
collectedAmountEstimate: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

odhad vybrané částky (zahrnuje i peníze, které jsou přislíbené, ale ještě nedorazily + matching)

donorsCount: int

odhad počtu dárců (zahrnuje i dárce, kteří přislíbily dar, ale jejichž peníze ještě nedorazily)

title: { ?cs: string ?en: string }

vícejazyčný název výzvy

synopsis: { ?cs: string ?en: string }

vícejazyčný krátký popis výzvy

content: { ?cs: string ?en: string }

vícejazyčný dlouhý text o výzvě (HTML formát)

targetAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

cílová částka

activeUntil: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum konce výzvy

imageHeader: null|{ url: string }

velký obrázek v hlavičce

donateUrl: string

URL vedoucí na darovací formulář

tags: [ { tagId: int

ID kategorie

label: { ?cs: string ?en: string }

název kategorie

}
0…∞
]

kategorie

video: null|{ url: string }

URL youtube videa

image: null|{ url: string }

obrázek

templateId: null|int

ID grafiky výzvy dle číselníku

donationMatching: anyOf null anyOf { fixedDonation: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

fixní částka pro matching

mustCollectAtLeast: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

}
{ donationPerOne: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka

mustCollectAtLeast: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

upperBound: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

maximální matching

}
suggestedAmounts: [ { primaryAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka v CZK

?secondaryAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["EUR"]
}

částka v EUR

description: { ?cs: string ?en: string }

vícejazyční popis částky

?default: bool

jedná se o defaltně vybranou částku?

}
0…∞
]

částky ve formuláři

}
}
#

Parameters

name type example description
promotionId inlined in path
string(^\d+\z)
4563

ID projektu

fromDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2017-10-01"

Od data

toDate optional
string(~^\d{4}-\d{2}-\d{2}$~)
"2017-10-30"

Do data

Body

{ promotionStats: { promotionId: int collectedAmountEstimate: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}
donorsCount: int
}
}
#

Body

{ promotion: { projectId: int

ID projektu

title: { ?cs: string ?en: string }

vícejazyčný název výzvy

synopsis: { ?cs: string ?en: string }

vícejazyčný krátký popis výzvy

content: { ?cs: string ?en: string }

vícejazyčný dlouhý text o výzvě (HTML formát)

targetAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

cílová částka

activeFrom: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum začátku výzvy

activeUntil: string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum konce výzvy

?video: string

URL youtube videa

?image: null|{ content: string

base64 encoded file

name: string

název souboru

}

obrázek

?banner: null|{ content: string

base64 encoded file

name: string

název souboru

}

banner

?templateId: int

ID grafiky výzvy dle číselníku

?donationMatching: anyOf null anyOf { fixedDonation: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

fixní částka pro matching

mustCollectAtLeast: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

}
{ donationPerOne: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka

mustCollectAtLeast: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

upperBound: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

maximální matching

}
?suggestedAmounts: [ { primaryAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka v CZK

?secondaryAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["EUR"]
}

částka v EUR

description: { ?cs: string ?en: string }

vícejazyční popis částky

?default: bool

jedná se o defaltně vybranou částku?

}
0…∞
]

částky ve formuláři

}
}

Body

{ promotion: { projectId: int

ID projektu

promotionId: int

ID výzvy

organization: { organizationId: int

ID organizace

name: string

název organizace

logo: null|{ url: string }

logo organizace

}
collectedAmountEstimate: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

odhad vybrané částky (zahrnuje i peníze, které jsou přislíbené, ale ještě nedorazily + matching)

donorsCount: int

odhad počtu dárců (zahrnuje i dárce, kteří přislíbily dar, ale jejichž peníze ještě nedorazily)

title: { ?cs: string ?en: string }

vícejazyčný název výzvy

synopsis: { ?cs: string ?en: string }

vícejazyčný krátký popis výzvy

content: { ?cs: string ?en: string }

vícejazyčný dlouhý text o výzvě (HTML formát)

targetAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: enum["CZK", "EUR", "GBP", "USD"]
}

cílová částka

activeUntil: null|string(~^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-]\d{2}:\d{2}$~)

datum konce výzvy

imageHeader: null|{ url: string }

velký obrázek v hlavičce

donateUrl: string

URL vedoucí na darovací formulář

tags: [ { tagId: int

ID kategorie

label: { ?cs: string ?en: string }

název kategorie

}
0…∞
]

kategorie

video: null|{ url: string }

URL youtube videa

image: null|{ url: string }

obrázek

templateId: null|int

ID grafiky výzvy dle číselníku

donationMatching: anyOf null anyOf { fixedDonation: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

fixní částka pro matching

mustCollectAtLeast: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

}
{ donationPerOne: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka

mustCollectAtLeast: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka, která se minimálně musí vybrat pro aktivaci matchingu

upperBound: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

maximální matching

}
suggestedAmounts: [ { primaryAmount: { cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["CZK"]
}

částka v CZK

?secondaryAmount: null|{ cents: int

počet setin základní jednotky (tj. např. počet haléřů pro částku v Kč)

currency: const["EUR"]
}

částka v EUR

description: { ?cs: string ?en: string }

vícejazyční popis částky

?default: bool

jedná se o defaltně vybranou částku?

}
0…∞
]

částky ve formuláři

}
}