get externaluri forurl
/members/{member}/externaluris/forurl [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9900 | 5.9900 | xml, json |
Description
Get an external URI (also known as URL).
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| returngroups | the groups to return in the output, can be "none","user","all" (administrator only) | no | string | none |
| url | the url for the external URI | yes | url |
Permission
Restricted to the member themselves or administrator.
Response
The output has the following format:
<uri id="[id]" path="[path]" ...>
<displaytitle>[title]</displaytitle>
...
[<usage hidden="2">
<group ... />
...
</usage>]
</uri>
Error Handling
No specific errors expected for this generator.