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 .xml suffix or ?format=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>