ClubReady Api

UserListDateAddedRequest

The following routes are available for this service:
GET	/users/date-added	List of users added in a certain date range.

import java.math.*
import java.util.*
import net.servicestack.client.*


open class UserListDateAddedRequest : UserListDateAddedRequestDto(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * Chain ID
    */
    @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

    /**
    * Store ID
    */
    @ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * UTC Format
    */
    @ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")
    var FromDate:Date? = null

    /**
    * Max 24 Hours (UTC Format)
    */
    @ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")
    var ToDate:Date? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class UserListDateAddedRequestDto : ApiDtoBase()
{
    var FromDate:Date? = null
    var ToDate:Date? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class UserListDateAddedResponse : UserListDateAddedResponseDto()
{
    var Users:ArrayList<ClubClient> = ArrayList<ClubClient>()
}

open class UserListDateAddedResponseDto
{
    var Users:ArrayList<ClubClient> = ArrayList<ClubClient>()
}

open class ClubClient
{
    var UserId:Int? = null
    var Username:String? = null
    var FirstName:String? = null
    var LastName:String? = null
    var StoreId:Int? = null
    var DateAdded:Date? = null
    var ReferredBy:Int? = null
    var AddedBy:Int? = null
    var ReferralTypeId:Int? = null
    var ReferralTypeName:String? = null
}

Kotlin UserListDateAddedRequest DTOs

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: 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>