ClubManager.Api

<back to all web services

MemberService.GetMemberRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Member/GetMember
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Interfaces.Models.Member
Imports ClubManager.Interfaces.Models.Message

Namespace Global

    Namespace ClubManager.Interfaces.Models.Member

        Public Enum ExternalStatus
            Off
            Active
            Pending
            CancelledInsideContract
            CancelledOutsideContract
            WithDebtRecovery
            Suspended
        End Enum

        Public Enum Gender
            Unknown
            Male
            Female
            Other
            PreferNotToSay
        End Enum

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

        Public Enum MembershipState
            Prospect
            Active
            Expired
            Cancelled
            PaymentRequired
            Suspended
        End Enum

        Public Enum MemberType
            Prospect
            Active
            Cancelled
            Expired
            Suspended
            ClubCancelled
            DropOut
        End Enum
    End Namespace

    Namespace ClubManager.Interfaces.Models.Message

        <Flags>
        Public Enum MessageTemplateContentType
            Transactional = 1
            Marketing = 2
            None = 1048576
        End Enum

        <Flags>
        Public Enum MessageTemplateType
            SMS = 1
            Email = 2
            Telephone = 4
            DirectMail = 8
            Notification = 16
            Page = 32
            None = 1048576
            NoConsent = 2097152
        End Enum
    End Namespace
End Namespace

VB.NET MemberService.GetMemberRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"MemberId":0}

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

{"MemberId":0,"BranchId":0,"MembershipNumber":"String","JoinedDate":"0001-01-01T00:00:00.0000000","CardNumber":"String","CompanyName":"String","Gender":"Unknown","GenderName":"String","FullName":"String","Title":"String","Forenames":"String","Surname":"String","Address1":"String","Address2":"String","County":"String","City":"String","HomePhone":"String","MobilePhone":"String","EmailAddress":"String","ExternalReference":"String","Country":"String","EmailOptOut":false,"SmsOptOut":false,"PhoneOptOut":false,"LetterOptOut":false,"UseExternalStatus":false,"ExternalStatus":"Off","DateOfBirth":"0001-01-01T00:00:00.0000000","Postcode":"String","Notes":"String","StartDate":"0001-01-01T00:00:00.0000000","Expires":"0001-01-01T00:00:00.0000000","SessionsRemaining":0,"ContractEndDate":"0001-01-01T00:00:00.0000000","DaysRemaining":0,"MembershipType":"String","LastAttendance":"0001-01-01T00:00:00.0000000","Attendance":0,"MemberType":"Prospect","RecurringPayments":0,"OverduePayments":0,"AttendanceThisWeek":0,"retentionMetric":0,"MonthlyAttendanceFrequency":0,"TotalProductSpend":0,"JournalEntry":"String","Balance":0,"CreditLimit":0,"guid":"00000000000000000000000000000000","MembershipState":"Prospect","BookingsAttended":0,"DateOfLastBooking":"0001-01-01T00:00:00.0000000","PhotoModifiedDate":"0001-01-01T00:00:00.0000000","CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","DeletedDate":"0001-01-01T00:00:00.0000000","MemberKey":"00000000000000000000000000000000","CreatedByUserId":0,"AssignedToUserId":0,"DeletedByUserId":0,"GiftAidPermission":false,"FirstAidPermission":false,"PhotoPermission":false,"EmergencyContact":"String","WonOrLost":0,"WonOrLostDate":"0001-01-01T00:00:00.0000000","WonOrLostByUserId":0,"LicenseReference":"String","LicenseStartDate":"0001-01-01T00:00:00.0000000","LicenseRenewalDate":"0001-01-01T00:00:00.0000000","AgreedToTerms":"0001-01-01T00:00:00.0000000","OnlineBookingBanned":false,"ChildBranchId":0,"ChildBranch":"String","ProspectingPoints":0,"AchievementPoints":0,"ParentForenames":"String","ParentSurname":"String","GradingReadiness":0,"DirectDebitAccountHolder":"String","DirectDebitAccountNumber":"String","DirectDebitSortCode":"String","DirectDebitBankAddress":"String","InvitedDate":"0001-01-01T00:00:00.0000000","Grade":"String","ColourLeft":"String","ColourRight":"String","SessionsToComplete":0,"UniqueId":"7UeZ5kavxWRMNAaGI7oAjVAlfbvJD6jGW9uZkWZZ4co=","PreferenceLink":"https://secure.clubmanagercentral.com/Portal/Login/Transfer?id=7UeZ5kavxWRMNAaGI7oAjYii6XuwMPMy1KilNm9eXI0%3d","MarketingAllLink":"https://secure.clubmanagercentral.com/Portal/Login/TransferOptInAll?id=7UeZ5kavxWRMNAaGI7oAjYii6XuwMPMy1KilNm9eXI0%3d","MarketingNoneLink":"https://secure.clubmanagercentral.com/Portal/Login/TransferOptOutAll?id=7UeZ5kavxWRMNAaGI7oAjYii6XuwMPMy1KilNm9eXI0%3d","AppRegistrationId":"tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLtXK66NblS5APNPs3d8xYZaZcP+/6zq56v36nQkIQTTwQ==","AppRegistrationLink":"https://secure.clubmanagercentral.com/Register?id=tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLtXK66NblS5APNPs3d8xYZaZcP+/6zq56v36nQkIQTTwQ==","AppQrImageLink":"https://secure.clubmanagercentral.com/Member.mvc/GetQrByMemberId?id=36xZln01EfE80ZF7GFWKkg==","CardNumberQrImageLink":"https://secure.clubmanagercentral.com/Member.mvc/GetCardNumberQRByMemberId?id=36xZln01EfE80ZF7GFWKkg==","PhotoThumbnailLink":"https://secure.clubmanagercentral.com/Member.mvc/GetPhotoThumbnailByMemberId?id=36xZln01EfE80ZF7GFWKkg==","ContentTypesOptIn":1,"TemplateTypesOptIn":1,"CanEmail":false,"CanDirectMail":false,"CanSMS":true,"CanTelephone":false,"NoMarketingConsent":false,"CanSendInvite":false,"BranchKey":"00000000000000000000000000000000","SageLink":"String","SageLastPaymentDate":"0001-01-01T00:00:00.0000000","SageFirstPaymentDate":"0001-01-01T00:00:00.0000000","SageLastPaymentAmount":0,"SageFirstPaymentAmount":0,"SageTotalPaid":0}