<back to all web services
UserVisitHistoryRequest
Gets user check-in history based on a date range. Max 31 days.
The following routes are available for this service:| GET | /users/{UserId}/visit-history | Get user visit history | |
|---|
UserVisitHistoryRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| UserId | query | integer | Yes | |
| StoreId | query | string | No | StoreId OR ChainId is required |
| ChainId | query | string | No | StoreId OR ChainId is required |
| FromDate | query | date | Yes | (Format:YYYY-MM-DD) |
| ToDate | query | date | Yes | Max 31 Days (Format:YYYY-MM-DD) |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
UserVisitHistoryRequestDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| UserId | form | int | No | |
| FromDate | form | DateTime | No | |
| ToDate | form | DateTime | 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 .csv suffix or ?format=csv
HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /users/{UserId}/visit-history HTTP/1.1
Host: clubready.com
Accept: text/csv