| POST,GET | /api/Member/GetMember |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class Member
{
var MemberId:Int? = null
var BranchId:Int? = null
var MembershipNumber:String? = null
var JoinedDate:Date? = null
var CardNumber:String? = null
var CompanyName:String? = null
var Gender:Gender? = null
var GenderName:String? = null
var FullName:String? = null
var Title:String? = null
var Forenames:String? = null
var Surname:String? = null
var Address1:String? = null
var Address2:String? = null
var County:String? = null
var City:String? = null
var HomePhone:String? = null
var MobilePhone:String? = null
var EmailAddress:String? = null
var ExternalReference:String? = null
var Country:String? = null
var EmailOptOut:Boolean? = null
var SmsOptOut:Boolean? = null
var PhoneOptOut:Boolean? = null
var LetterOptOut:Boolean? = null
var UseExternalStatus:Boolean? = null
var ExternalStatus:ExternalStatus? = null
var DateOfBirth:Date? = null
var Postcode:String? = null
var Notes:String? = null
var StartDate:Date? = null
var Expires:Date? = null
var SessionsRemaining:Int? = null
var ContractEndDate:Date? = null
var DaysRemaining:Int? = null
var MembershipType:String? = null
var LastAttendance:Date? = null
var Attendance:Int? = null
var MemberType:MemberType? = null
var RecurringPayments:Int? = null
var OverduePayments:Int? = null
var AttendanceThisWeek:Int? = null
var retentionMetric:BigDecimal? = null
var MonthlyAttendanceFrequency:BigDecimal? = null
var TotalProductSpend:BigDecimal? = null
var JournalEntry:String? = null
var Balance:BigDecimal? = null
var CreditLimit:BigDecimal? = null
var guid:UUID? = null
var MembershipState:MembershipState? = null
var BookingsAttended:Int? = null
var DateOfLastBooking:Date? = null
var PhotoModifiedDate:Date? = null
var CreatedDate:Date? = null
var ModifiedDate:Date? = null
var DeletedDate:Date? = null
var MemberKey:UUID? = null
var CreatedByUserId:Int? = null
var AssignedToUserId:Int? = null
var DeletedByUserId:Int? = null
var GiftAidPermission:Boolean? = null
var FirstAidPermission:Boolean? = null
var PhotoPermission:Boolean? = null
var EmergencyContact:String? = null
var WonOrLost:Int? = null
var WonOrLostDate:Date? = null
var WonOrLostByUserId:Int? = null
var LicenseReference:String? = null
var LicenseStartDate:Date? = null
var LicenseRenewalDate:Date? = null
var AgreedToTerms:Date? = null
var OnlineBookingBanned:Boolean? = null
var ChildBranchId:Int? = null
var ChildBranch:String? = null
var ProspectingPoints:Int? = null
var AchievementPoints:Int? = null
var ParentForenames:String? = null
var ParentSurname:String? = null
var GradingReadiness:Int? = null
var DirectDebitAccountHolder:String? = null
var DirectDebitAccountNumber:String? = null
var DirectDebitSortCode:String? = null
var DirectDebitBankAddress:String? = null
var InvitedDate:Date? = null
var Grade:String? = null
var ColourLeft:String? = null
var ColourRight:String? = null
var SessionsToComplete:Int? = null
var UniqueId:String? = null
var PreferenceLink:String? = null
var MarketingAllLink:String? = null
var MarketingNoneLink:String? = null
var AppRegistrationId:String? = null
var AppRegistrationLink:String? = null
var AppQrImageLink:String? = null
var CardNumberQrImageLink:String? = null
var PhotoThumbnailLink:String? = null
var ContentTypesOptIn:MessageTemplateContentType? = null
var TemplateTypesOptIn:MessageTemplateType? = null
var CanEmail:Boolean? = null
var CanDirectMail:Boolean? = null
var CanSMS:Boolean? = null
var CanTelephone:Boolean? = null
var NoMarketingConsent:Boolean? = null
var CanSendInvite:Boolean? = null
var BranchKey:UUID? = null
var SageLink:String? = null
var SageLastPaymentDate:Date? = null
var SageFirstPaymentDate:Date? = null
var SageLastPaymentAmount:BigDecimal? = null
var SageFirstPaymentAmount:BigDecimal? = null
var SageTotalPaid:BigDecimal? = null
}
enum class Gender
{
Unknown,
Male,
Female,
Other,
PreferNotToSay,
}
enum class ExternalStatus
{
Off,
Active,
Pending,
CancelledInsideContract,
CancelledOutsideContract,
WithDebtRecovery,
Suspended,
}
enum class MemberType
{
Prospect,
Active,
Cancelled,
Expired,
Suspended,
ClubCancelled,
DropOut,
}
enum class MembershipState
{
Prospect,
Active,
Expired,
Cancelled,
PaymentRequired,
Suspended,
}
@Flags()
enum class MessageTemplateContentType(val value:Int)
{
@SerializedName("1") Transactional(1),
@SerializedName("2") Marketing(2),
@SerializedName("1048576") None(1048576),
}
@Flags()
enum class MessageTemplateType(val value:Int)
{
@SerializedName("1") Sms(1),
@SerializedName("2") Email(2),
@SerializedName("4") Telephone(4),
@SerializedName("8") DirectMail(8),
@SerializedName("16") Notification(16),
@SerializedName("32") Page(32),
@SerializedName("1048576") None(1048576),
@SerializedName("2097152") NoConsent(2097152),
}
Kotlin MemberService.GetMemberRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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":"7UeZ5kavxWRMNAaGI7oAjdoMKufMeU3uTJHsr/h+a24=","PreferenceLink":"https://secure.clubmanagercentral.com/Portal/Login/Transfer?id=7UeZ5kavxWRMNAaGI7oAjdoMKufMeU3uTJHsr%2fh%2ba24%3d","MarketingAllLink":"https://secure.clubmanagercentral.com/Portal/Login/TransferOptInAll?id=7UeZ5kavxWRMNAaGI7oAjdoMKufMeU3uTJHsr%2fh%2ba24%3d","MarketingNoneLink":"https://secure.clubmanagercentral.com/Portal/Login/TransferOptOutAll?id=7UeZ5kavxWRMNAaGI7oAjdoMKufMeU3uTJHsr%2fh%2ba24%3d","AppRegistrationId":"tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLvYx1RHXoeZDrrEwIuHDwDDp/9uXRT9lxXk9pVFWjXOww==","AppRegistrationLink":"https://secure.clubmanagercentral.com/Register?id=tdEETnrE2UDYoDHYyiFtLUFbiv0Psfko1F+WdmLSeeLOfNJrwIXoKym0RGXbqDsBIcwMpLHhEzKbJbIzcmw6pzckMg2FYdjFlmJyfSP0eLvYx1RHXoeZDrrEwIuHDwDDp/9uXRT9lxXk9pVFWjXOww==","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}