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 .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/date-added HTTP/1.1 
Host: 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>