Files
oc-server3/htdocs/okapi/services/users/by_usernames.xml
2014-10-08 10:06:07 +02:00

24 lines
1.0 KiB
XML

<xml>
<brief>Find multiple users, by their usernames</brief>
<issue-id>25</issue-id>
<desc>
<p>This method works like the services/users/by_username method, but works
with multiple users (instead of only one).</p>
</desc>
<req name='usernames'>
<p>Pipe-separated list of usernames. No more than 500 are allowed.</p>
</req>
<req name='fields'>
<p>Same as in the services/users/user method. Pipe-separated list
of field names which you are interested with.
See services/users/user method for a list available values.</p>
</req>
<common-format-params/>
<returns>
<p>A dictionary. Usernames you provide will be mapped to dictionary keys,
and each value will be a dictionary of fields you have selected.</p>
<p>Value of <b>null</b> means that the given user haven't been found.
(This behavior is different than in the services/users/by_username method, which
responds with an HTTP 400 error in such case.)</p>
</returns>
</xml>