canmove, Confirmed users
2,745
edits
Mozillians/API-Specification/List Users/: Difference between revisions
Mozillians/API-Specification/List Users/ (view source)
Revision as of 21:02, 4 October 2012
, 4 October 2012→Arguments
Bsternthal (talk | contribs) |
Bsternthal (talk | contribs) |
||
| Line 6: | Line 6: | ||
== Arguments == | == Arguments == | ||
{| class="wikitable" style="font-size:13px" | |||
|- | |||
! style='padding:.0 .8em 0 .8em;white-space:nowrap' | Argument | |||
! style='padding:.0 .8em 0 .8em;white-space:nowrap;width:100px;' | Type | |||
! style='padding:.0 .8em 0 .8em;white-space:nowrap' | Required | |||
! style='padding:.0 .8em 0 .8em;white-space:nowrap;width:300px;' | Mozilla App Only | |||
! style='width:50%'| Description | |||
|- | |||
| '''app_name''' | |||
| string | |||
| style="text-align:center" | Y | |||
| style="text-align:center" | N | |||
| Your registered app name. This is case sensitive. | |||
|- | |||
| '''app_key''' | |||
| string | |||
| style="text-align:center" | Y | |||
| style="text-align:center" | N | |||
| Your app key | |||
|- | |||
| '''is_vouched''' | |||
| string <br/> [true false] | |||
| style="text-align:center" | N | |||
| style="text-align:center" | N (Required For Community) | |||
| Flag to return users that are vouched or not. | |||
|- | |||
| '''email''' | |||
| string | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Return user with matching email. | |||
|- | |||
| '''country''' | |||
| string | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Return users with matching country. | |||
|- | |||
| '''region''' | |||
| string | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Return users with matching region. | |||
|- | |||
| '''city''' | |||
| string | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Return users with matching city. | |||
|- | |||
| '''skills''' | |||
| string | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Return users with matching skills. Skills can be comma separated to filter users with any matched skills. | |||
|- | |||
| '''languages''' | |||
| string | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Return users with matching languages. Languages can be comma separated to filter users with any matched languages. | |||
|- | |||
| '''groups''' | |||
| string | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Return users with matching groups. Groups can be comma separated to filter users with any matched groups. | |||
|- | |||
| '''limit''' | |||
| integer | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Limit answer to [number] results. | |||
|- | |||
| '''offset''' | |||
| integer | |||
| style="text-align:center" | N | |||
| style="text-align:center" | Y | |||
| Skip [number] results. Defaults to 0. | |||
|- | |||
| '''format''' | |||
| string <br/> [json xml] | |||
| style="text-align:center" | N | |||
| style="text-align:center" | N | |||
| Reply in this format. Defaults to 'json'. | |||
|} | |||
== Example Response == | == Example Response == | ||
== Error Codes == | == Error Codes == | ||