almet/ihatemoney
1
0
Fork 0
mirror of https://github.com/spiral-project/ihatemoney.git synced 2025-04-28 17:32:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Explain better multi-valued payed_for in API doc

Browse source 
… And use a multi-valued example, as it's IMHO the "standard" use-case with
IHM.
This commit is contained in:
Jocelyn Delalande 2016-08-18 18:06:37 +02:00
parent 74b087fe6a
commit 338f735d46
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/api.rst
View file

@ -138,14 +138,14 @@ following params:
* `date`: the date of the bill; defaults to current date if not provided. (yy-mm-dd)
* `what`: what have been payed
* `payer`: by who ? (id)
* `payed_for`: list of ids
* `payed_for`: for who ? (id, repeat the parameter to set multiple id)
* `amount`: amount payed
Returns the id of the created bill ::
$ curl --basic -u demo:demo -X POST\
http://ihatemoney.notmyidea.org/api/projects/demo/bills\
-d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=200"
-d "date=2011-09-10&what=raclette&payer=31&payed_for=31&payed_for=35&amount=200"
80
You can also `PUT` a new version of the bill at
@ -153,7 +153,7 @@ You can also `PUT` a new version of the bill at
$ curl --basic -u demo:demo -X PUT\
http://ihatemoney.notmyidea.org/api/projects/demo/bills/80\
-d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=250"
-d "date=2011-09-10&what=raclette&payer=31&payed_for=31&payed_for=35&amount=250"
80
And you can of course `DELETE` them at `/api/projects/<id>/bills/<bill-id>`::