ClubManager.Api

<back to all web services

MemberService.GetMemberRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Member/GetMember
namespace ClubManager.Interfaces.Models.Member

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type Gender =
        | Unknown = 0
        | Male = 1
        | Female = 2
        | Other = 3
        | PreferNotToSay = 4

    type ExternalStatus =
        | Off = 0
        | Active = 1
        | Pending = 2
        | CancelledInsideContract = 3
        | CancelledOutsideContract = 4
        | WithDebtRecovery = 5
        | Suspended = 6

    type MemberType =
        | Prospect = 0
        | Active = 1
        | Cancelled = 2
        | Expired = 3
        | Suspended = 4
        | ClubCancelled = 5
        | DropOut = 6

    type MembershipState =
        | Prospect = 0
        | Active = 1
        | Expired = 2
        | Cancelled = 3
        | PaymentRequired = 4
        | Suspended = 5

    [<Flags>]
    type MessageTemplateContentType =
        | Transactional = 1
        | Marketing = 2
        | None = 1048576

    [<Flags>]
    type MessageTemplateType =
        | SMS = 1
        | Email = 2
        | Telephone = 4
        | DirectMail = 8
        | Notification = 16
        | Page = 32
        | None = 1048576
        | NoConsent = 2097152

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

F# 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>