| POST,GET | /api/Member/GetMember |
|---|
import Foundation
import ServiceStack
public class Member : Codable
{
public var memberId:Int?
public var branchId:Int?
public var membershipNumber:String?
public var joinedDate:Date?
public var cardNumber:String?
public var companyName:String?
public var gender:Gender?
public var genderName:String?
public var fullName:String?
public var title:String?
public var forenames:String?
public var surname:String?
public var address1:String?
public var address2:String?
public var county:String?
public var city:String?
public var homePhone:String?
public var mobilePhone:String?
public var emailAddress:String?
public var externalReference:String?
public var country:String?
public var emailOptOut:Bool?
public var smsOptOut:Bool?
public var phoneOptOut:Bool?
public var letterOptOut:Bool?
public var useExternalStatus:Bool?
public var externalStatus:ExternalStatus?
public var dateOfBirth:Date?
public var postcode:String?
public var notes:String?
public var startDate:Date?
public var expires:Date?
public var sessionsRemaining:Int?
public var contractEndDate:Date?
public var daysRemaining:Int?
public var membershipType:String?
public var lastAttendance:Date?
public var attendance:Int?
public var memberType:MemberType?
public var recurringPayments:Int?
public var overduePayments:Int?
public var attendanceThisWeek:Int?
public var retentionMetric:Double?
public var monthlyAttendanceFrequency:Double?
public var totalProductSpend:Double?
public var journalEntry:String?
public var balance:Double?
public var creditLimit:Double?
public var guid:String?
public var membershipState:MembershipState?
public var bookingsAttended:Int?
public var dateOfLastBooking:Date?
public var photoModifiedDate:Date?
public var createdDate:Date?
public var modifiedDate:Date?
public var deletedDate:Date?
public var memberKey:String?
public var createdByUserId:Int?
public var assignedToUserId:Int?
public var deletedByUserId:Int?
public var giftAidPermission:Bool?
public var firstAidPermission:Bool?
public var photoPermission:Bool?
public var emergencyContact:String?
public var wonOrLost:Int?
public var wonOrLostDate:Date?
public var wonOrLostByUserId:Int?
public var licenseReference:String?
public var licenseStartDate:Date?
public var licenseRenewalDate:Date?
public var agreedToTerms:Date?
public var onlineBookingBanned:Bool?
public var childBranchId:Int?
public var childBranch:String?
public var prospectingPoints:Int?
public var achievementPoints:Int?
public var parentForenames:String?
public var parentSurname:String?
public var gradingReadiness:Int?
public var directDebitAccountHolder:String?
public var directDebitAccountNumber:String?
public var directDebitSortCode:String?
public var directDebitBankAddress:String?
public var invitedDate:Date?
public var grade:String?
public var colourLeft:String?
public var colourRight:String?
public var sessionsToComplete:Int?
public var uniqueId:String?
public var preferenceLink:String?
public var marketingAllLink:String?
public var marketingNoneLink:String?
public var appRegistrationId:String?
public var appRegistrationLink:String?
public var appQrImageLink:String?
public var cardNumberQrImageLink:String?
public var photoThumbnailLink:String?
public var contentTypesOptIn:MessageTemplateContentType?
public var templateTypesOptIn:MessageTemplateType?
public var canEmail:Bool?
public var canDirectMail:Bool?
public var canSMS:Bool?
public var canTelephone:Bool?
public var noMarketingConsent:Bool?
public var canSendInvite:Bool?
public var branchKey:String?
public var sageLink:String?
public var sageLastPaymentDate:Date?
public var sageFirstPaymentDate:Date?
public var sageLastPaymentAmount:Double?
public var sageFirstPaymentAmount:Double?
public var sageTotalPaid:Double?
required public init(){}
}
public enum Gender : String, Codable
{
case Unknown
case Male
case Female
case Other
case PreferNotToSay
}
public enum ExternalStatus : String, Codable
{
case Off
case Active
case Pending
case CancelledInsideContract
case CancelledOutsideContract
case WithDebtRecovery
case Suspended
}
public enum MemberType : String, Codable
{
case Prospect
case Active
case Cancelled
case Expired
case Suspended
case ClubCancelled
case DropOut
}
public enum MembershipState : String, Codable
{
case Prospect
case Active
case Expired
case Cancelled
case PaymentRequired
case Suspended
}
// @Flags()
public enum MessageTemplateContentType : Int, Codable
{
case Transactional = 1
case Marketing = 2
case None = 1048576
}
// @Flags()
public enum MessageTemplateType : Int, Codable
{
case SMS = 1
case Email = 2
case Telephone = 4
case DirectMail = 8
case Notification = 16
case Page = 32
case None = 1048576
case NoConsent = 2097152
}
Swift 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>