ClubReady Api

<back to all web services

UserAccountInfoRequest

The following routes are available for this service:
GET/users/{UserId}Get user account summary
UserAccountInfoRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
UserIdqueryintegerYes(debug id) Jen A = 28975
StoreIdqueryintegerNoStoreId OR ChainId is required
ChainIdqueryintegerNoStoreId OR ChainId is required
FullDetailqueryBooleanNoWhether you want full detail to be returned or a basic User object. (Format: true|false(default))
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
UserAccountInfoRequestDto Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
FullDetailformboolNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users/{UserId} HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml