<back to all web services
SearchUsersRequest
The following routes are available for this service:GET | /users/find | Find a member. | |
---|
SearchUsersRequest Parameters:Name | Parameter | Data Type | Required | Description |
---|
ApiKey | query | string | Yes | Api Key - grants access to resources |
FirstName | query | string | No | Filter by First Name |
LastName | query | string | No | Filter by Last Name |
StoreId | query | integer | No | StoreId OR ChainId is required |
ChainId | query | string | No | StoreId OR ChainId is required |
Barcode | query | string | No | Filter by barcode |
Email | query | string | No | Filter by Email Address |
Phone | query | string | No | Filter by Phone Number |
UserType | query | integer | No | Filter by ClubReady User Type |
Page | query | integer | No | Page of users to retrieve. Pulls back 100 users per page. |
RestrictedId | query | int? | No | |
RestrictedResourceType | query | RestrictedResourceType | No | |
SearchUsersRequestDto Parameters:Name | Parameter | Data Type | Required | Description |
---|
Barcode | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Email | form | string | No | |
Phone | form | string | No | |
UserType | form | int? | No | |
Page | form | int? | 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/find HTTP/1.1
Host: clubready.com
Accept: text/csv