ClubReady Api

<back to all web services

GetAllUsersRequest

import Foundation
import ServiceStack

public class GetAllUsersRequest : GetAllUsersRequestDto, IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public var apiKey:String

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

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

    /**
    * Include deleted users in result? (defaults to false)
    */
    // @ApiMember(DataType="bool", Description="Include deleted users in result? (defaults to false)", Name="IncludeDeleted", ParameterType="query")
    public var includeDeleted:Bool

    /**
    * Max number of records to include in the response.
    */
    // @ApiMember(DataType="int", Description="Max number of records to include in the response.", Name="PageSize", ParameterType="query")
    public var pageSize:Int?

    /**
    * Page number to retrieve.
    */
    // @ApiMember(DataType="int", Description="Page number to retrieve.", Name="PageNumber", ParameterType="query")
    public var pageNumber:Int?

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case chainId
        case storeId
        case includeDeleted
        case pageSize
        case pageNumber
        case restrictedId
        case restrictedResourceType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
        chainId = try container.decodeIfPresent(Int.self, forKey: .chainId)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        includeDeleted = try container.decodeIfPresent(Bool.self, forKey: .includeDeleted)
        pageSize = try container.decodeIfPresent(Int.self, forKey: .pageSize)
        pageNumber = try container.decodeIfPresent(Int.self, forKey: .pageNumber)
        restrictedId = try container.decodeIfPresent(Int.self, forKey: .restrictedId)
        restrictedResourceType = try container.decodeIfPresent(RestrictedResourceType.self, forKey: .restrictedResourceType)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
        if chainId != nil { try container.encode(chainId, forKey: .chainId) }
        if storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if includeDeleted != nil { try container.encode(includeDeleted, forKey: .includeDeleted) }
        if pageSize != nil { try container.encode(pageSize, forKey: .pageSize) }
        if pageNumber != nil { try container.encode(pageNumber, forKey: .pageNumber) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
    }
}

public class GetAllUsersRequestDto : ApiDtoBase
{
    public var includeDeleted:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case includeDeleted
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        includeDeleted = try container.decodeIfPresent(Bool.self, forKey: .includeDeleted)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if includeDeleted != nil { try container.encode(includeDeleted, forKey: .includeDeleted) }
    }
}

public class ApiDtoBase : Codable
{
    public var apiKey:String
    public var storeId:Int?
    public var chainId:Int?

    required public init(){}
}

public enum RestrictedResourceType : String, Codable
{
    case Store
    case Chain
    case User
    case Undefined
}

Swift GetAllUsersRequest DTOs

GET /club/{StoreId}/Users/all HTTP/1.1 
Host: clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		UserId: 0,
		Prospect: False,
		Member: False,
		DateAdded: 0001-01-01,
		Email: String,
		FirstName: String,
		LastName: String,
		StoreId: 0,
		Username: String,
		Address: String,
		City: String,
		State: String,
		Zip: String,
		Barcode: String,
		Phone: String,
		CellPhone: String,
		ExternalUserId: String,
		ProspectTypeName: String,
		DateOfBirth: String,
		MemberSinceDate: String,
		MembershipExpiresDate: String,
		MembershipEndedDate: String,
		EmailOptOut: False,
		SmsOptOut: False,
		SmsOptIn: False,
		ReferralTypeId: 0,
		ReferralTypeName: String
	}
]