<back to all web services
UserAccountInfoRequest
The following routes are available for this service:| GET | /users/{UserId} | Get user account summary | |
|---|
UserAccountInfoRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| XForwardedFor | header | string | No | IP address of the end user |
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| UserId | query | integer | Yes | (debug id) Jen A = 28975 |
| StoreId | query | integer | No | StoreId OR ChainId is required |
| ChainId | query | integer | No | StoreId OR ChainId is required |
| FullDetail | query | Boolean | No | Whether you want full detail to be returned or a basic User object. (Format: true|false(default)) |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
UserAccountInfoRequestDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| UserId | form | int | No | |
| FullDetail | form | bool | No | |
ApiDtoBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | 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