IT4Change/gradido
3
0
Fork 0
mirror of https://github.com/IT4Change/gradido.git synced 2025-12-13 07:45:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Dario Rekowski on RockPI 2021-08-05 12:12:50 +00:00
parent 402a0af5c1
commit 79f80e2af8
1 changed files with 7 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docu/community-server.api.md
View File

@ -163,19 +163,14 @@ Assuming session was valid and gdt server was setup correct
"id": 10, "id": 10,
"amount": 100.12, "amount": 100.12,
"date": "2021-07-28T13:58:00+00:00", "date": "2021-07-28T13:58:00+00:00",
"email": "tester2@gmail.com",
"comment": null, "comment": null,
"coupon_code": "", "coupon_code": "",
"gdt_entry_type_id": 4, "gdt_entry_type_id": 4,
"factor": 15, "factor": 15,
"amount2": 0, "amount2": 0,
"factor2": 0.05, "factor2": 0.05,
"gdt": 75.09000000000002, "gdt": 75.09000000000002
"publisher": {
"id": 12,
"first_name": "Dario",
"last_name": "Frodo",
"email": "dariofrodo@gmx.de"
}
}, },
{ {
"id": 6, "id": 6,
@ -194,35 +189,31 @@ Assuming session was valid and gdt server was setup correct
"id": 8, "id": 8,
"amount": 10, "amount": 10,
"date": "2021-07-31T13:58:00+00:00", "date": "2021-07-31T13:58:00+00:00",
"email": "tester1@gmail.com",
"comment": null, "comment": null,
"coupon_code": "", "coupon_code": "",
"gdt_entry_type_id": 4, "gdt_entry_type_id": 4,
"factor": 15, "factor": 15,
"amount2": 0, "amount2": 0,
"factor2": 0.05, "factor2": 0.05,
"gdt": 7.5, "gdt": 7.5
"publisher": {
"id": 12,
"first_name": "Dario",
"last_name": "Frodo",
"email": "dariofrodo@gmx.de"
}
} }
], ],
"gdtSum": 2220.99, "gdtSum": 2220.99,
"timeUsed": 0.19156503677368165 "timeUsed": 0.012517929077148438
} }
- `count`: Count of total gdt transactions for user - `count`: Count of total gdt transactions for user
- `gdtEntries`: array with gdt entries, sort by date - `gdtEntries`: array with gdt entries, sort by date
- `amount`: amount of payed money in euro, expect by gdt_entry_type_id = 7, then it is GDT Sum for Global Modificator time span - `amount`: amount of payed money in euro, expect by gdt_entry_type_id = 7, then it is GDT Sum for Global Modificator time span
- `date`: date of transaction with let create gdt transaction, date for picking factor and Global Modificator - `date`: date of transaction with let create gdt transaction, date for picking factor and Global Modificator
- `email`: email of user which has payed money, for gdt_entry_type_id = 4 it is the email of user who was recruited
- `comment`: custom comment or Global Modificator name if gdt_entry_type_id = 7 - `comment`: custom comment or Global Modificator name if gdt_entry_type_id = 7
- `gdt_entry_type_id`: type of gdt entry - `gdt_entry_type_id`: type of gdt entry
(1) Form: Single GDT Entry directly created by admin via formular (1) Form: Single GDT Entry directly created by admin via formular
(2) CVS: Created by importing a CVS-List with multiple GDT Entries (2) CVS: Created by importing a CVS-List with multiple GDT Entries
(3) Elopage: Automatic created by Elopage Transaction (with revenue > 0 and payment state success) (3) Elopage: Automatic created by Elopage Transaction (with revenue > 0 and payment state success)
(4) Elopage Publisher: Automatic created by Elopage Transaction (with revenue > 0 and payment state success) for publisher, containing publisher object (4) Elopage Publisher: Automatic created by Elopage Transaction (with revenue > 0 and payment state success) for publisher
(5) Digistore: Automatic created by Digistore Transaction (5) Digistore: Automatic created by Digistore Transaction
(6) CVS2: Created by importing a CVS-List with multiple GDT Entries, other format (used by Bernds old Accounting Tool) (6) CVS2: Created by importing a CVS-List with multiple GDT Entries, other format (used by Bernds old Accounting Tool)
(7) Global Modificator: Global Modificator which grand percental bonus on GDT in possession in event time span (7) Global Modificator: Global Modificator which grand percental bonus on GDT in possession in event time span
@ -230,7 +221,6 @@ Assuming session was valid and gdt server was setup correct
- `amount2`: Bonus add amount for gdt, sparly used - `amount2`: Bonus add amount for gdt, sparly used
- `factor2`: Bonus mulitplication factor used by elopage publisher entry - `factor2`: Bonus mulitplication factor used by elopage publisher entry
- `gdt`: GDT Value, calculatedt from other value: gdt = amount * factor * factor2 + amount2 - `gdt`: GDT Value, calculatedt from other value: gdt = amount * factor * factor2 + amount2
- `publisher`: exist only on Elopage Publisher (gdt_entry_type_id = 4) GDT Entries
- `gdtSum`: Total GDT Sum of user - `gdtSum`: Total GDT Sum of user
- `timeUsed`: GDT Server isn't optimized, this is for easy checking if it is still fast enough - `timeUsed`: GDT Server isn't optimized, this is for easy checking if it is still fast enough