ClubReady Api

<back to all web services

UserAccountRequest

export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class UserAccountRequestDto extends ApiDtoBase
{
    public UserId: number;
    public FirstName: string;
    public LastName: string;
    public HomePhone: string;
    public CellPhone: string;
    public Address1: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Email: string;
    public Gender: string;
    public DateOfBirth?: string;
    public Username: string;
    public ExternalId: string;
    public EmergencyContactName: string;
    public EmergencyContactPhone: string;
    public EmergencyContactType: string;
    public ProspectTypeId?: number;

    public constructor(init?: Partial<UserAccountRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class UserAccountRequest extends UserAccountRequestDto implements IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * 
    */
    // @ApiMember(DataType="integer", Description="", IsRequired=true, Name="UserId", ParameterType="query")
    public UserId: number;

    /**
    * StoreId OR ChainId is required
    */
    // @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")
    public StoreId?: number;

    /**
    * StoreId OR ChainId is required
    */
    // @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="FirstName", ParameterType="query")
    public FirstName: string;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="LastName", ParameterType="query")
    public LastName: string;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="HomePhone", ParameterType="query")
    public HomePhone: string;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="CellPhone", ParameterType="query")
    public CellPhone: string;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="Address1", ParameterType="query")
    public Address1: string;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="City", ParameterType="query")
    public City: string;

    /**
    * (Format:2 characters; Example:'MO')
    */
    // @ApiMember(DataType="string", Description="(Format:2 characters; Example:'MO')", Name="State", ParameterType="query")
    public State: string;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="Zip", ParameterType="query")
    public Zip: string;

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="", Name="Email", ParameterType="query")
    public Email: string;

    /**
    * Gender (Format:'M'|'F')
    */
    // @ApiMember(DataType="string", Description="Gender (Format:'M'|'F')", Name="Gender", ParameterType="query")
    public Gender: string;

    /**
    * Date of Birth (Format:YYYY-MM-DD)
    */
    // @ApiMember(DataType="date", Description="Date of Birth (Format:YYYY-MM-DD)", Name="DateOfBirth", ParameterType="query")
    public DateOfBirth?: string;

    /**
    * Username should be between 4 and 255 characters long
    */
    // @ApiMember(DataType="string", Description="Username should be between 4 and 255 characters long", Name="Username", ParameterType="query")
    public Username: string;

    /**
    * Unique ID for the user from your system. We store internally as ExternalUserId
    */
    // @ApiMember(DataType="string", Description="Unique ID for the user from your system. We store internally as ExternalUserId", Name="ExternalId", ParameterType="query")
    public ExternalId: string;

    /**
    * Emergency contact name
    */
    // @ApiMember(DataType="string", Description="Emergency contact name", Name="EmergencyContactName", ParameterType="query")
    public EmergencyContactName: string;

    /**
    * Emergency contact phone number
    */
    // @ApiMember(DataType="string", Description="Emergency contact phone number", Name="EmergencyContactPhone", ParameterType="query")
    public EmergencyContactPhone: string;

    /**
    * Emergency contact relationship
    */
    // @ApiMember(DataType="string", Description="Emergency contact relationship", Name="EmergencyContactType", ParameterType="query")
    public EmergencyContactType: string;

    /**
    * Prospect Type Id
    */
    // @ApiMember(DataType="integer", Description="Prospect Type Id", Name="ProspectTypeId", ParameterType="query")
    public ProspectTypeId?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<UserAccountRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UserAccountRequest DTOs

PUT /users/{UserId} HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	UserId: 0,
	StoreId: 0,
	ChainId: 0,
	FirstName: String,
	LastName: String,
	HomePhone: String,
	CellPhone: String,
	Address1: String,
	City: String,
	State: String,
	Zip: String,
	Email: String,
	Gender: String,
	DateOfBirth: 0001-01-01,
	Username: String,
	ExternalId: String,
	EmergencyContactName: String,
	EmergencyContactPhone: String,
	EmergencyContactType: String,
	ProspectTypeId: 0,
	RestrictedId: 0,
	RestrictedResourceType: User
}