ClubManager.Api

<back to all web services

MemberService.GetMemberRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Member/GetMember
import java.math.*
import java.util.*
import net.servicestack.client.*


open class Member
{
    var MemberId:Int? = null
    var BranchId:Int? = null
    var MembershipNumber:String? = null
    var JoinedDate:Date? = null
    var CardNumber:String? = null
    var CompanyName:String? = null
    var Gender:Gender? = null
    var GenderName:String? = null
    var FullName:String? = null
    var Title:String? = null
    var Forenames:String? = null
    var Surname:String? = null
    var Address1:String? = null
    var Address2:String? = null
    var County:String? = null
    var City:String? = null
    var HomePhone:String? = null
    var MobilePhone:String? = null
    var EmailAddress:String? = null
    var ExternalReference:String? = null
    var Country:String? = null
    var EmailOptOut:Boolean? = null
    var SmsOptOut:Boolean? = null
    var PhoneOptOut:Boolean? = null
    var LetterOptOut:Boolean? = null
    var UseExternalStatus:Boolean? = null
    var ExternalStatus:ExternalStatus? = null
    var DateOfBirth:Date? = null
    var Postcode:String? = null
    var Notes:String? = null
    var StartDate:Date? = null
    var Expires:Date? = null
    var SessionsRemaining:Int? = null
    var ContractEndDate:Date? = null
    var DaysRemaining:Int? = null
    var MembershipType:String? = null
    var LastAttendance:Date? = null
    var Attendance:Int? = null
    var MemberType:MemberType? = null
    var RecurringPayments:Int? = null
    var OverduePayments:Int? = null
    var AttendanceThisWeek:Int? = null
    var retentionMetric:BigDecimal? = null
    var MonthlyAttendanceFrequency:BigDecimal? = null
    var TotalProductSpend:BigDecimal? = null
    var JournalEntry:String? = null
    var Balance:BigDecimal? = null
    var CreditLimit:BigDecimal? = null
    var guid:UUID? = null
    var MembershipState:MembershipState? = null
    var BookingsAttended:Int? = null
    var DateOfLastBooking:Date? = null
    var PhotoModifiedDate:Date? = null
    var CreatedDate:Date? = null
    var ModifiedDate:Date? = null
    var DeletedDate:Date? = null
    var MemberKey:UUID? = null
    var CreatedByUserId:Int? = null
    var AssignedToUserId:Int? = null
    var DeletedByUserId:Int? = null
    var GiftAidPermission:Boolean? = null
    var FirstAidPermission:Boolean? = null
    var PhotoPermission:Boolean? = null
    var EmergencyContact:String? = null
    var WonOrLost:Int? = null
    var WonOrLostDate:Date? = null
    var WonOrLostByUserId:Int? = null
    var LicenseReference:String? = null
    var LicenseStartDate:Date? = null
    var LicenseRenewalDate:Date? = null
    var AgreedToTerms:Date? = null
    var OnlineBookingBanned:Boolean? = null
    var ChildBranchId:Int? = null
    var ChildBranch:String? = null
    var ProspectingPoints:Int? = null
    var AchievementPoints:Int? = null
    var ParentForenames:String? = null
    var ParentSurname:String? = null
    var GradingReadiness:Int? = null
    var DirectDebitAccountHolder:String? = null
    var DirectDebitAccountNumber:String? = null
    var DirectDebitSortCode:String? = null
    var DirectDebitBankAddress:String? = null
    var InvitedDate:Date? = null
    var Grade:String? = null
    var ColourLeft:String? = null
    var ColourRight:String? = null
    var SessionsToComplete:Int? = null
    var UniqueId:String? = null
    var PreferenceLink:String? = null
    var MarketingAllLink:String? = null
    var MarketingNoneLink:String? = null
    var AppRegistrationId:String? = null
    var AppRegistrationLink:String? = null
    var AppQrImageLink:String? = null
    var CardNumberQrImageLink:String? = null
    var PhotoThumbnailLink:String? = null
    var ContentTypesOptIn:MessageTemplateContentType? = null
    var TemplateTypesOptIn:MessageTemplateType? = null
    var CanEmail:Boolean? = null
    var CanDirectMail:Boolean? = null
    var CanSMS:Boolean? = null
    var CanTelephone:Boolean? = null
    var NoMarketingConsent:Boolean? = null
    var CanSendInvite:Boolean? = null
    var BranchKey:UUID? = null
    var SageLink:String? = null
    var SageLastPaymentDate:Date? = null
    var SageFirstPaymentDate:Date? = null
    var SageLastPaymentAmount:BigDecimal? = null
    var SageFirstPaymentAmount:BigDecimal? = null
    var SageTotalPaid:BigDecimal? = null
}

enum class Gender
{
    Unknown,
    Male,
    Female,
    Other,
    PreferNotToSay,
}

enum class ExternalStatus
{
    Off,
    Active,
    Pending,
    CancelledInsideContract,
    CancelledOutsideContract,
    WithDebtRecovery,
    Suspended,
}

enum class MemberType
{
    Prospect,
    Active,
    Cancelled,
    Expired,
    Suspended,
    ClubCancelled,
    DropOut,
}

enum class MembershipState
{
    Prospect,
    Active,
    Expired,
    Cancelled,
    PaymentRequired,
    Suspended,
}

@Flags()
enum class MessageTemplateContentType(val value:Int)
{
    @SerializedName("1") Transactional(1),
    @SerializedName("2") Marketing(2),
    @SerializedName("1048576") None(1048576),
}

@Flags()
enum class MessageTemplateType(val value:Int)
{
    @SerializedName("1") Sms(1),
    @SerializedName("2") Email(2),
    @SerializedName("4") Telephone(4),
    @SerializedName("8") DirectMail(8),
    @SerializedName("16") Notification(16),
    @SerializedName("32") Page(32),
    @SerializedName("1048576") None(1048576),
    @SerializedName("2097152") NoConsent(2097152),
}

Kotlin MemberService.GetMemberRequest 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.

POST /api/Member/GetMember HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MemberService.GetMemberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services">
  <MemberId>0</MemberId>
</MemberService.GetMemberRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Member xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Models.Member">
  <_x003C_AchievementPoints_x003E_k__BackingField>0</_x003C_AchievementPoints_x003E_k__BackingField>
  <_x003C_Address1_x003E_k__BackingField>String</_x003C_Address1_x003E_k__BackingField>
  <_x003C_Address2_x003E_k__BackingField>String</_x003C_Address2_x003E_k__BackingField>
  <_x003C_AgreedToTerms_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_AgreedToTerms_x003E_k__BackingField>
  <_x003C_AssignedToUserId_x003E_k__BackingField>0</_x003C_AssignedToUserId_x003E_k__BackingField>
  <_x003C_AttendanceThisWeek_x003E_k__BackingField>0</_x003C_AttendanceThisWeek_x003E_k__BackingField>
  <_x003C_Attendance_x003E_k__BackingField>0</_x003C_Attendance_x003E_k__BackingField>
  <_x003C_Balance_x003E_k__BackingField>0</_x003C_Balance_x003E_k__BackingField>
  <_x003C_BookingsAttended_x003E_k__BackingField>0</_x003C_BookingsAttended_x003E_k__BackingField>
  <_x003C_BranchId_x003E_k__BackingField>0</_x003C_BranchId_x003E_k__BackingField>
  <_x003C_BranchKey_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_BranchKey_x003E_k__BackingField>
  <_x003C_CardNumber_x003E_k__BackingField>String</_x003C_CardNumber_x003E_k__BackingField>
  <_x003C_ChildBranchId_x003E_k__BackingField>0</_x003C_ChildBranchId_x003E_k__BackingField>
  <_x003C_ChildBranch_x003E_k__BackingField>String</_x003C_ChildBranch_x003E_k__BackingField>
  <_x003C_City_x003E_k__BackingField>String</_x003C_City_x003E_k__BackingField>
  <_x003C_ColourLeft_x003E_k__BackingField>String</_x003C_ColourLeft_x003E_k__BackingField>
  <_x003C_ColourRight_x003E_k__BackingField>String</_x003C_ColourRight_x003E_k__BackingField>
  <_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
  <_x003C_ContentTypesOptIn_x003E_k__BackingField>Transactional</_x003C_ContentTypesOptIn_x003E_k__BackingField>
  <_x003C_ContractEndDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ContractEndDate_x003E_k__BackingField>
  <_x003C_Country_x003E_k__BackingField>String</_x003C_Country_x003E_k__BackingField>
  <_x003C_County_x003E_k__BackingField>String</_x003C_County_x003E_k__BackingField>
  <_x003C_CreatedByUserId_x003E_k__BackingField>0</_x003C_CreatedByUserId_x003E_k__BackingField>
  <_x003C_CreatedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_CreatedDate_x003E_k__BackingField>
  <_x003C_CreditLimit_x003E_k__BackingField>0</_x003C_CreditLimit_x003E_k__BackingField>
  <_x003C_DateOfBirth_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateOfBirth_x003E_k__BackingField>
  <_x003C_DateOfLastBooking_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateOfLastBooking_x003E_k__BackingField>
  <_x003C_DaysRemaining_x003E_k__BackingField>0</_x003C_DaysRemaining_x003E_k__BackingField>
  <_x003C_DeletedByUserId_x003E_k__BackingField>0</_x003C_DeletedByUserId_x003E_k__BackingField>
  <_x003C_DeletedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DeletedDate_x003E_k__BackingField>
  <_x003C_DirectDebitAccountHolder_x003E_k__BackingField>String</_x003C_DirectDebitAccountHolder_x003E_k__BackingField>
  <_x003C_DirectDebitAccountNumber_x003E_k__BackingField>String</_x003C_DirectDebitAccountNumber_x003E_k__BackingField>
  <_x003C_DirectDebitBankAddress_x003E_k__BackingField>String</_x003C_DirectDebitBankAddress_x003E_k__BackingField>
  <_x003C_DirectDebitSortCode_x003E_k__BackingField>String</_x003C_DirectDebitSortCode_x003E_k__BackingField>
  <_x003C_EmailAddress_x003E_k__BackingField>String</_x003C_EmailAddress_x003E_k__BackingField>
  <_x003C_EmailOptOut_x003E_k__BackingField>false</_x003C_EmailOptOut_x003E_k__BackingField>
  <_x003C_EmergencyContact_x003E_k__BackingField>String</_x003C_EmergencyContact_x003E_k__BackingField>
  <_x003C_Expires_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_Expires_x003E_k__BackingField>
  <_x003C_ExternalReference_x003E_k__BackingField>String</_x003C_ExternalReference_x003E_k__BackingField>
  <_x003C_ExternalStatus_x003E_k__BackingField>Off</_x003C_ExternalStatus_x003E_k__BackingField>
  <_x003C_FirstAidPermission_x003E_k__BackingField>false</_x003C_FirstAidPermission_x003E_k__BackingField>
  <_x003C_Forenames_x003E_k__BackingField>String</_x003C_Forenames_x003E_k__BackingField>
  <_x003C_FullName_x003E_k__BackingField>String</_x003C_FullName_x003E_k__BackingField>
  <_x003C_GenderName_x003E_k__BackingField>String</_x003C_GenderName_x003E_k__BackingField>
  <_x003C_Gender_x003E_k__BackingField>Unknown</_x003C_Gender_x003E_k__BackingField>
  <_x003C_GiftAidPermission_x003E_k__BackingField>false</_x003C_GiftAidPermission_x003E_k__BackingField>
  <_x003C_Grade_x003E_k__BackingField>String</_x003C_Grade_x003E_k__BackingField>
  <_x003C_GradingReadiness_x003E_k__BackingField>0</_x003C_GradingReadiness_x003E_k__BackingField>
  <_x003C_HomePhone_x003E_k__BackingField>String</_x003C_HomePhone_x003E_k__BackingField>
  <_x003C_InvitedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_InvitedDate_x003E_k__BackingField>
  <_x003C_JoinedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_JoinedDate_x003E_k__BackingField>
  <_x003C_JournalEntry_x003E_k__BackingField>String</_x003C_JournalEntry_x003E_k__BackingField>
  <_x003C_LastAttendance_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastAttendance_x003E_k__BackingField>
  <_x003C_LetterOptOut_x003E_k__BackingField>false</_x003C_LetterOptOut_x003E_k__BackingField>
  <_x003C_LicenseReference_x003E_k__BackingField>String</_x003C_LicenseReference_x003E_k__BackingField>
  <_x003C_LicenseRenewalDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LicenseRenewalDate_x003E_k__BackingField>
  <_x003C_LicenseStartDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LicenseStartDate_x003E_k__BackingField>
  <_x003C_MemberId_x003E_k__BackingField>0</_x003C_MemberId_x003E_k__BackingField>
  <_x003C_MemberKey_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_MemberKey_x003E_k__BackingField>
  <_x003C_MemberType_x003E_k__BackingField>Prospect</_x003C_MemberType_x003E_k__BackingField>
  <_x003C_MembershipNumber_x003E_k__BackingField>String</_x003C_MembershipNumber_x003E_k__BackingField>
  <_x003C_MembershipState_x003E_k__BackingField>Prospect</_x003C_MembershipState_x003E_k__BackingField>
  <_x003C_MembershipType_x003E_k__BackingField>String</_x003C_MembershipType_x003E_k__BackingField>
  <_x003C_MobilePhone_x003E_k__BackingField>String</_x003C_MobilePhone_x003E_k__BackingField>
  <_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
  <_x003C_MonthlyAttendanceFrequency_x003E_k__BackingField>0</_x003C_MonthlyAttendanceFrequency_x003E_k__BackingField>
  <_x003C_Notes_x003E_k__BackingField>String</_x003C_Notes_x003E_k__BackingField>
  <_x003C_OnlineBookingBanned_x003E_k__BackingField>false</_x003C_OnlineBookingBanned_x003E_k__BackingField>
  <_x003C_OverduePayments_x003E_k__BackingField>0</_x003C_OverduePayments_x003E_k__BackingField>
  <_x003C_ParentForenames_x003E_k__BackingField>String</_x003C_ParentForenames_x003E_k__BackingField>
  <_x003C_ParentSurname_x003E_k__BackingField>String</_x003C_ParentSurname_x003E_k__BackingField>
  <_x003C_PhoneOptOut_x003E_k__BackingField>false</_x003C_PhoneOptOut_x003E_k__BackingField>
  <_x003C_PhotoModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_PhotoModifiedDate_x003E_k__BackingField>
  <_x003C_PhotoPermission_x003E_k__BackingField>false</_x003C_PhotoPermission_x003E_k__BackingField>
  <_x003C_Postcode_x003E_k__BackingField>String</_x003C_Postcode_x003E_k__BackingField>
  <_x003C_ProspectingPoints_x003E_k__BackingField>0</_x003C_ProspectingPoints_x003E_k__BackingField>
  <_x003C_RecurringPayments_x003E_k__BackingField>0</_x003C_RecurringPayments_x003E_k__BackingField>
  <_x003C_SageFirstPaymentAmount_x003E_k__BackingField>0</_x003C_SageFirstPaymentAmount_x003E_k__BackingField>
  <_x003C_SageFirstPaymentDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_SageFirstPaymentDate_x003E_k__BackingField>
  <_x003C_SageLastPaymentAmount_x003E_k__BackingField>0</_x003C_SageLastPaymentAmount_x003E_k__BackingField>
  <_x003C_SageLastPaymentDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_SageLastPaymentDate_x003E_k__BackingField>
  <_x003C_SageLink_x003E_k__BackingField>String</_x003C_SageLink_x003E_k__BackingField>
  <_x003C_SageTotalPaid_x003E_k__BackingField>0</_x003C_SageTotalPaid_x003E_k__BackingField>
  <_x003C_SessionsRemaining_x003E_k__BackingField>0</_x003C_SessionsRemaining_x003E_k__BackingField>
  <_x003C_SessionsToComplete_x003E_k__BackingField>0</_x003C_SessionsToComplete_x003E_k__BackingField>
  <_x003C_SmsOptOut_x003E_k__BackingField>false</_x003C_SmsOptOut_x003E_k__BackingField>
  <_x003C_StartDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_StartDate_x003E_k__BackingField>
  <_x003C_Surname_x003E_k__BackingField>String</_x003C_Surname_x003E_k__BackingField>
  <_x003C_TemplateTypesOptIn_x003E_k__BackingField>SMS</_x003C_TemplateTypesOptIn_x003E_k__BackingField>
  <_x003C_Title_x003E_k__BackingField>String</_x003C_Title_x003E_k__BackingField>
  <_x003C_TotalProductSpend_x003E_k__BackingField>0</_x003C_TotalProductSpend_x003E_k__BackingField>
  <_x003C_UseExternalStatus_x003E_k__BackingField>false</_x003C_UseExternalStatus_x003E_k__BackingField>
  <_x003C_WonOrLostByUserId_x003E_k__BackingField>0</_x003C_WonOrLostByUserId_x003E_k__BackingField>
  <_x003C_WonOrLostDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_WonOrLostDate_x003E_k__BackingField>
  <_x003C_WonOrLost_x003E_k__BackingField>0</_x003C_WonOrLost_x003E_k__BackingField>
  <_x003C_guid_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_guid_x003E_k__BackingField>
  <_x003C_retentionMetric_x003E_k__BackingField>0</_x003C_retentionMetric_x003E_k__BackingField>
</Member>