Skip to content

Commit

Permalink
Add more api call descriptions to client
Browse files Browse the repository at this point in the history
  • Loading branch information
keegancsmith committed Apr 26, 2012
1 parent 5e3ef5a commit 0ee5912
Show file tree
Hide file tree
Showing 2 changed files with 523 additions and 24 deletions.
24 changes: 12 additions & 12 deletions pages/api/index.txt
Expand Up @@ -45,10 +45,10 @@ Add your new client **josh**
"class": "client", "class": "client",
"client": { "client": {
"depth": 0, "depth": 0,
"id": 94, "id": 126,
"xid": "Bad:Be", "xid": "Bad:B-",
"state": "new", "state": "new",
"number": "059", "number": "091",
"name": "josh", "name": "josh",
"firstname": "josh", "firstname": "josh",
"surname": "", "surname": "",
Expand Down Expand Up @@ -83,8 +83,8 @@ Add your new client **josh**
"paid_payments": 0 "paid_payments": 0
}, },
"urls": { "urls": {
"statement": "https://demo.snapbill.com/statement/Bad:Be/HmjPUIYMCuHK", "statement": "https://demo.snapbill.com/statement/Bad:B-/u9J3mYUSmc1c",
"payment": "https://demo.snapbill.com/payment/client/Bad:Be/ZS1xL7HQQLtQ" "payment": "https://demo.snapbill.com/payment/client/Bad:B-/LwqRg4oMOpvj"
}, },
"services": [] "services": []
} }
Expand All @@ -108,10 +108,10 @@ Search for clients named **josh**
"list": [ "list": [
{ {
"depth": 0, "depth": 0,
"id": 94, "id": 126,
"xid": "Bad:Be", "xid": "Bad:B-",
"state": "new", "state": "new",
"number": "059", "number": "091",
"name": "josh", "name": "josh",
"firstname": "josh", "firstname": "josh",
"surname": "", "surname": "",
Expand Down Expand Up @@ -146,8 +146,8 @@ Search for clients named **josh**
"paid_payments": 0 "paid_payments": 0
}, },
"urls": { "urls": {
"statement": "http://debitor.snap/statement/Bad:Be/HmjPUIYMCuHK", "statement": "http://debitor.snap/statement/Bad:B-/u9J3mYUSmc1c",
"payment": "http://debitor.snap/payment/client/Bad:Be/ZS1xL7HQQLtQ" "payment": "http://debitor.snap/payment/client/Bad:B-/LwqRg4oMOpvj"
}, },
"services": [] "services": []
} }
Expand All @@ -159,7 +159,7 @@ Search for clients named **josh**
Change the clients name to **george** Change the clients name to **george**
<pre class="prettyprint"><div class="input"> <pre class="prettyprint"><div class="input">
$ curl -u user:pass -d "firstname=george" \ $ curl -u user:pass -d "firstname=george" \
> https://api.snapbill.com/v1/client/94/update.json > https://api.snapbill.com/v1/client/126/update.json
</div><div class="output"> </div><div class="output">
{ {
"code": 200, "code": 200,
Expand All @@ -172,7 +172,7 @@ Change the clients name to **george**
Remove the client Remove the client
<pre class="prettyprint"><div class="input"> <pre class="prettyprint"><div class="input">
$ curl -u user:pass -d "" \ $ curl -u user:pass -d "" \
> https://api.snapbill.com/v1/client/94/delete.json > https://api.snapbill.com/v1/client/126/delete.json
</div><div class="output"> </div><div class="output">
{ {
"code": 200, "code": 200,
Expand Down

0 comments on commit 0ee5912

Please sign in to comment.