Difference between revisions of "WebAPI/ResolveVanityURL"

From Team Fortress Wiki
Jump to: navigation, search
(Also trying a different documentation style, we can't rely on things like response object roots being "result" anymore)
 
(Result Data: It might go without saying, but it *is* optional.)
Line 10: Line 10:
  
 
;response:
 
;response:
:;steamid: The 64 bit Steam ID the vanity URL resolves to.
 
 
:;success: The status of the request. 1 if successful, 42 if there was no match.
 
:;success: The status of the request. 1 if successful, 42 if there was no match.
 +
:;steamid ''(<span style="color: red;">Optional</span>)'': The 64 bit Steam ID the vanity URL resolves to. Not returned on resolution failures.
 
:;message ''(<span style="color: red;">Optional</span>)'': The message associated with the request status. Currently only used on resolution failures.
 
:;message ''(<span style="color: red;">Optional</span>)'': The message associated with the request status. Currently only used on resolution failures.
  
 
{{Languages|WebAPI/ResolveVanityURL}}
 
{{Languages|WebAPI/ResolveVanityURL}}
 
[[Category:WebAPI|ResolveVanityURL]]
 
[[Category:WebAPI|ResolveVanityURL]]

Revision as of 07:33, 8 December 2011

URL

http://api.steampowered.com/ISteamUser/ResolveVanityURL/v0001/

See the ID list for a valid ID.

Method-specific Parameters

vanityurl
The vanity URL part of a user's Steam profile URL. This is the basename of http://steamcommunity.com/id/ URLs.

Result Data

response
success
The status of the request. 1 if successful, 42 if there was no match.
steamid (Optional)
The 64 bit Steam ID the vanity URL resolves to. Not returned on resolution failures.
message (Optional)
The message associated with the request status. Currently only used on resolution failures.