| POST,GET | /api/Member/GetMemberByKey |
|---|
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.GetMemberByKeyRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Member/GetMemberByKey HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
MemberKey: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
MemberId: 0,
BranchId: 0,
MembershipNumber: String,
JoinedDate: 0001-01-01,
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-01,
Postcode: String,
Notes: String,
StartDate: 0001-01-01,
Expires: 0001-01-01,
SessionsRemaining: 0,
ContractEndDate: 0001-01-01,
DaysRemaining: 0,
MembershipType: String,
LastAttendance: 0001-01-01,
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-01,
PhotoModifiedDate: 0001-01-01,
CreatedDate: 0001-01-01,
ModifiedDate: 0001-01-01,
DeletedDate: 0001-01-01,
MemberKey: 00000000000000000000000000000000,
CreatedByUserId: 0,
AssignedToUserId: 0,
DeletedByUserId: 0,
GiftAidPermission: False,
FirstAidPermission: False,
PhotoPermission: False,
EmergencyContact: String,
WonOrLost: 0,
WonOrLostDate: 0001-01-01,
WonOrLostByUserId: 0,
LicenseReference: String,
LicenseStartDate: 0001-01-01,
LicenseRenewalDate: 0001-01-01,
AgreedToTerms: 0001-01-01,
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-01,
Grade: String,
ColourLeft: String,
ColourRight: String,
SessionsToComplete: 0,
UniqueId: 7UeZ5kavxWRMNAaGI7oAja9gOOFNHQ/DN8E/dkZYH4M=,
PreferenceLink: "https://secure.clubmanagercentral.com/Portal/Login/Transfer?id=7UeZ5kavxWRMNAaGI7oAja9gOOFNHQ%2fDN8E%2fdkZYH4M%3d",
MarketingAllLink: "https://secure.clubmanagercentral.com/Portal/Login/TransferOptInAll?id=7UeZ5kavxWRMNAaGI7oAja9gOOFNHQ%2fDN8E%2fdkZYH4M%3d",
MarketingNoneLink: "https://secure.clubmanagercentral.com/Portal/Login/TransferOptOutAll?id=7UeZ5kavxWRMNAaGI7oAja9gOOFNHQ%2fDN8E%2fdkZYH4M%3d",
AppRegistrationId: tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLuqFkTPzilvX/vL0SoF/qCcVdBUmybmrfYywFkcAlLr5w==,
AppRegistrationLink: "https://secure.clubmanagercentral.com/Register?id=tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLuqFkTPzilvX/vL0SoF/qCcVdBUmybmrfYywFkcAlLr5w==",
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-01,
SageFirstPaymentDate: 0001-01-01,
SageLastPaymentAmount: 0,
SageFirstPaymentAmount: 0,
SageTotalPaid: 0
}