| POST,GET | /api/Member/GetMember |
|---|
export enum Gender
{
Unknown = 'Unknown',
Male = 'Male',
Female = 'Female',
Other = 'Other',
PreferNotToSay = 'PreferNotToSay',
}
export enum ExternalStatus
{
Off = 'Off',
Active = 'Active',
Pending = 'Pending',
CancelledInsideContract = 'CancelledInsideContract',
CancelledOutsideContract = 'CancelledOutsideContract',
WithDebtRecovery = 'WithDebtRecovery',
Suspended = 'Suspended',
}
export enum MemberType
{
Prospect = 'Prospect',
Active = 'Active',
Cancelled = 'Cancelled',
Expired = 'Expired',
Suspended = 'Suspended',
ClubCancelled = 'ClubCancelled',
DropOut = 'DropOut',
}
export enum MembershipState
{
Prospect = 'Prospect',
Active = 'Active',
Expired = 'Expired',
Cancelled = 'Cancelled',
PaymentRequired = 'PaymentRequired',
Suspended = 'Suspended',
}
// @Flags()
export enum MessageTemplateContentType
{
Transactional = 1,
Marketing = 2,
None = 1048576,
}
// @Flags()
export enum MessageTemplateType
{
SMS = 1,
Email = 2,
Telephone = 4,
DirectMail = 8,
Notification = 16,
Page = 32,
None = 1048576,
NoConsent = 2097152,
}
export class Member
{
public MemberId?: number;
public BranchId?: number;
public MembershipNumber?: string;
public JoinedDate?: string;
public CardNumber?: string;
public CompanyName?: string;
public Gender?: Gender;
public GenderName?: string;
public FullName?: string;
public Title?: string;
public Forenames?: string;
public Surname?: string;
public Address1?: string;
public Address2?: string;
public County?: string;
public City?: string;
public HomePhone?: string;
public MobilePhone?: string;
public EmailAddress?: string;
public ExternalReference?: string;
public Country?: string;
public EmailOptOut?: boolean;
public SmsOptOut?: boolean;
public PhoneOptOut?: boolean;
public LetterOptOut?: boolean;
public UseExternalStatus?: boolean;
public ExternalStatus?: ExternalStatus;
public DateOfBirth?: string;
public Postcode?: string;
public Notes?: string;
public StartDate?: string;
public Expires?: string;
public SessionsRemaining?: number;
public ContractEndDate?: string;
public DaysRemaining?: number;
public MembershipType?: string;
public LastAttendance?: string;
public Attendance?: number;
public MemberType?: MemberType;
public RecurringPayments?: number;
public OverduePayments?: number;
public AttendanceThisWeek?: number;
public retentionMetric?: number;
public MonthlyAttendanceFrequency?: number;
public TotalProductSpend?: number;
public JournalEntry?: string;
public Balance?: number;
public CreditLimit?: number;
public guid?: string;
public MembershipState?: MembershipState;
public BookingsAttended?: number;
public DateOfLastBooking?: string;
public PhotoModifiedDate?: string;
public CreatedDate?: string;
public ModifiedDate?: string;
public DeletedDate?: string;
public MemberKey?: string;
public CreatedByUserId?: number;
public AssignedToUserId?: number;
public DeletedByUserId?: number;
public GiftAidPermission?: boolean;
public FirstAidPermission?: boolean;
public PhotoPermission?: boolean;
public EmergencyContact?: string;
public WonOrLost?: number;
public WonOrLostDate?: string;
public WonOrLostByUserId?: number;
public LicenseReference?: string;
public LicenseStartDate?: string;
public LicenseRenewalDate?: string;
public AgreedToTerms?: string;
public OnlineBookingBanned?: boolean;
public ChildBranchId?: number;
public ChildBranch?: string;
public ProspectingPoints?: number;
public AchievementPoints?: number;
public ParentForenames?: string;
public ParentSurname?: string;
public GradingReadiness?: number;
public DirectDebitAccountHolder?: string;
public DirectDebitAccountNumber?: string;
public DirectDebitSortCode?: string;
public DirectDebitBankAddress?: string;
public InvitedDate?: string;
public Grade?: string;
public ColourLeft?: string;
public ColourRight?: string;
public SessionsToComplete?: number;
public UniqueId?: string;
public PreferenceLink?: string;
public MarketingAllLink?: string;
public MarketingNoneLink?: string;
public AppRegistrationId?: string;
public AppRegistrationLink?: string;
public AppQrImageLink?: string;
public CardNumberQrImageLink?: string;
public PhotoThumbnailLink?: string;
public ContentTypesOptIn?: MessageTemplateContentType;
public TemplateTypesOptIn?: MessageTemplateType;
public CanEmail?: boolean;
public CanDirectMail?: boolean;
public CanSMS?: boolean;
public CanTelephone?: boolean;
public NoMarketingConsent?: boolean;
public CanSendInvite?: boolean;
public BranchKey?: string;
public SageLink?: string;
public SageLastPaymentDate?: string;
public SageFirstPaymentDate?: string;
public SageLastPaymentAmount?: number;
public SageFirstPaymentAmount?: number;
public SageTotalPaid?: number;
public constructor(init?: Partial<Member>) { (Object as any).assign(this, init); }
}
TypeScript MemberService.GetMemberRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"MemberId":0}
HTTP/1.1 200 OK
Content-Type: application/json
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":"7UeZ5kavxWRMNAaGI7oAjZqVrH6Avl6OC376+s+IiL4=","PreferenceLink":"https://secure.clubmanagercentral.com/Portal/Login/Transfer?id=7UeZ5kavxWRMNAaGI7oAjZqVrH6Avl6OC376%2bs%2bIiL4%3d","MarketingAllLink":"https://secure.clubmanagercentral.com/Portal/Login/TransferOptInAll?id=7UeZ5kavxWRMNAaGI7oAjZqVrH6Avl6OC376%2bs%2bIiL4%3d","MarketingNoneLink":"https://secure.clubmanagercentral.com/Portal/Login/TransferOptOutAll?id=7UeZ5kavxWRMNAaGI7oAjZqVrH6Avl6OC376%2bs%2bIiL4%3d","AppRegistrationId":"tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLuM82qyV1Vh9g5XFqisze+5psAUsRu3TCRne9j8llkikw==","AppRegistrationLink":"https://secure.clubmanagercentral.com/Register?id=tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLuM82qyV1Vh9g5XFqisze+5psAUsRu3TCRne9j8llkikw==","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}