| GET | /users/date-added | List of users added in a certain date range. |
|---|
| 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 |
| ChainId | query | integer | No | Chain ID |
| StoreId | query | integer | No | Store ID |
| FromDate | query | date | Yes | UTC Format |
| ToDate | query | date | Yes | Max 24 Hours (UTC Format) |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FromDate | form | DateTime | No | |
| ToDate | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No |
| Store | |
| Chain | |
| User | |
| Undefined |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Users | form | List<ClubClient> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Users | form | List<ClubClient> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | int | No | |
| Username | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| StoreId | form | int? | No | |
| DateAdded | form | DateTime? | No | |
| ReferredBy | form | int? | No | |
| AddedBy | form | int? | No | |
| ReferralTypeId | form | int? | No | |
| ReferralTypeName | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/date-added HTTP/1.1 Host: www.clubready.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserListDateAddedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
<Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Users.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
<d2p1:ClubClient>
<d2p1:AddedBy>0</d2p1:AddedBy>
<d2p1:DateAdded>0001-01-01T00:00:00</d2p1:DateAdded>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:ReferralTypeId>0</d2p1:ReferralTypeId>
<d2p1:ReferralTypeName>String</d2p1:ReferralTypeName>
<d2p1:ReferredBy>0</d2p1:ReferredBy>
<d2p1:StoreId>0</d2p1:StoreId>
<d2p1:UserId>0</d2p1:UserId>
<d2p1:Username>String</d2p1:Username>
</d2p1:ClubClient>
</Users>
</UserListDateAddedResponse>