Retrieve member ID for a nickname
Retrieves the member ID for the member, given their nickname.
URL: | https://api.trademe.co.nz/v1/Member/{memberName}.{file_format} |
---|---|
HTTP Method: | GET |
Requires Authentication? | Yes |
Permission Required: | None |
Supported Formats: | XML, JSON |
Rate Limited? | Yes |
URL parameters
memberName | String (required) |
The member nickname. |
||||
---|---|---|---|---|---|---|
file_format | Enumeration (required) | The format of the response. | ||||
|
Query String parameters
suggestion | Boolean (optional) |
Indicates whether to include a suggested alternative nickname if the provided nickname is in use. Defaults to false. |
---|
Returns
<MemberIdFromNickname>
The member ID for the user with the given nickname.
Id | Integer |
The ID of the member with the given nickname |
---|---|---|
Suggestion | String or null |
An alternative nickname for registration if the given nickname is in use and query string parameter 'suggestion' equals 'true' |
Examples
https://api.trademe.co.nz/v1/Member/Sam.xml - If the nickname 'Sam' is use, retrieves the member ID for the nickname 'Sam'.
https://api.trademe.co.nz/v1/Member/Sam.xml?suggestion=true - If the nickname 'Sam' is use, retrieves the member ID for the nickname 'Sam' and a suggested alternative nickname for registration.