comparison docs/api/api.rst @ 3940:3a608d72a86f beta

api.rst edited online with Bitbucket See bugid #847
author Ton Plomp <tcplomp@gmail.com>
date Sat, 25 May 2013 16:01:41 +0000
parents 647fb653048e
children 5293d4bbb1ea
comparison
equal deleted inserted replaced
3939:584ec42af63d 3940:3a608d72a86f
321 321
322 id : <id_given_in_input> 322 id : <id_given_in_input>
323 result: [ 323 result: [
324 { 324 {
325 "user_id" : "<user_id>", 325 "user_id" : "<user_id>",
326 "api_key" : "<api_key>",
326 "username" : "<username>", 327 "username" : "<username>",
327 "firstname": "<firstname>", 328 "firstname": "<firstname>",
328 "lastname" : "<lastname>", 329 "lastname" : "<lastname>",
329 "email" : "<email>", 330 "email" : "<email>",
330 "emails": "<list_of_all_additional_emails>", 331 "emails": "<list_of_all_additional_emails>",
412 id : <id_given_in_input> 413 id : <id_given_in_input>
413 result: { 414 result: {
414 "msg" : "updated user ID:<userid> <username>", 415 "msg" : "updated user ID:<userid> <username>",
415 "user": { 416 "user": {
416 "user_id" : "<user_id>", 417 "user_id" : "<user_id>",
418 "api_key" : "<api_key>",
417 "username" : "<username>", 419 "username" : "<username>",
418 "firstname": "<firstname>", 420 "firstname": "<firstname>",
419 "lastname" : "<lastname>", 421 "lastname" : "<lastname>",
420 "email" : "<email>", 422 "email" : "<email>",
421 "emails": "<list_of_all_additional_emails>", 423 "emails": "<list_of_all_additional_emails>",
480 "group_name" : "<groupname>", 482 "group_name" : "<groupname>",
481 "active": "<bool>", 483 "active": "<bool>",
482 "members" : [ 484 "members" : [
483 { 485 {
484 "user_id" : "<user_id>", 486 "user_id" : "<user_id>",
487 "api_key" : "<api_key>",
485 "username" : "<username>", 488 "username" : "<username>",
486 "firstname": "<firstname>", 489 "firstname": "<firstname>",
487 "lastname" : "<lastname>", 490 "lastname" : "<lastname>",
488 "email" : "<email>", 491 "email" : "<email>",
489 "emails": "<list_of_all_additional_emails>", 492 "emails": "<list_of_all_additional_emails>",
662 "fork_of": "<name_of_fork_parent>", 665 "fork_of": "<name_of_fork_parent>",
663 "members" : [ 666 "members" : [
664 { 667 {
665 "type": "user", 668 "type": "user",
666 "user_id" : "<user_id>", 669 "user_id" : "<user_id>",
670 "api_key" : "<api_key>",
667 "username" : "<username>", 671 "username" : "<username>",
668 "firstname": "<firstname>", 672 "firstname": "<firstname>",
669 "lastname" : "<lastname>", 673 "lastname" : "<lastname>",
670 "email" : "<email>", 674 "email" : "<email>",
671 "emails": "<list_of_all_additional_emails>", 675 "emails": "<list_of_all_additional_emails>",
687 ] 691 ]
688 "followers": [ 692 "followers": [
689 { 693 {
690 "user_id" : "<user_id>", 694 "user_id" : "<user_id>",
691 "username" : "<username>", 695 "username" : "<username>",
696 "api_key" : "<api_key>",
692 "firstname": "<firstname>", 697 "firstname": "<firstname>",
693 "lastname" : "<lastname>", 698 "lastname" : "<lastname>",
694 "email" : "<email>", 699 "email" : "<email>",
695 "emails": "<list_of_all_additional_emails>", 700 "emails": "<list_of_all_additional_emails>",
696 "ip_addresses": "<list_of_ip_addresses_for_user>", 701 "ip_addresses": "<list_of_ip_addresses_for_user>",