ClubReady Api

<back to all web services

UserListDateAddedRequest

The following routes are available for this service:
GET/users/date-addedList of users added in a certain date range.
UserListDateAddedRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoChain ID
StoreIdqueryintegerNoStore ID
FromDatequerydateYesUTC Format
ToDatequerydateYesMax 24 Hours (UTC Format)
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
UserListDateAddedRequestDto Parameters:
NameParameterData TypeRequiredDescription
FromDateformDateTimeNo
ToDateformDateTimeNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
UserListDateAddedResponse Parameters:
NameParameterData TypeRequiredDescription
UsersformList<ClubClient>No
UserListDateAddedResponseDto Parameters:
NameParameterData TypeRequiredDescription
UsersformList<ClubClient>No
ClubClient Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UsernameformstringNo
FirstNameformstringNo
LastNameformstringNo
StoreIdformint?No
DateAddedformDateTime?No
ReferredByformint?No
AddedByformint?No
ReferralTypeIdformint?No
ReferralTypeNameformstringNo

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/date-added HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Users":[{"UserId":0,"Username":"String","FirstName":"String","LastName":"String","StoreId":0,"DateAdded":"0001-01-01T00:00:00.0000000","ReferredBy":0,"AddedBy":0,"ReferralTypeId":0,"ReferralTypeName":"String"}]}