| Required role: | API |
| All Verbs | /api/Query/Member |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
skip: Optional[int] = None
take: Optional[int] = None
order_by: Optional[str] = None
order_by_desc: Optional[str] = None
include: Optional[str] = None
fields: Optional[str] = None
meta: Optional[Dict[str, str]] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
@staticmethod
def response_type(): return QueryResponse[T]
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LossReasonInstance:
loss_reason_id: Optional[int] = None
reason: Optional[str] = None
deleted: Optional[bool] = None
demo: Optional[bool] = None
selectable: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserInstance:
user_id: Optional[int] = None
user_name: Optional[str] = None
name: Optional[str] = None
email: Optional[str] = None
mobile_phone: Optional[str] = None
enabled: Optional[bool] = None
last_login: Optional[datetime.datetime] = None
created: Optional[datetime.datetime] = None
training: Optional[bool] = None
deleted: Optional[bool] = None
courses_completed: Optional[int] = None
display_home_notification: Optional[bool] = None
two_factor_enabled: Optional[bool] = None
email_confirmed: Optional[bool] = None
mobile_phone_confirmed: Optional[bool] = None
notifications: Optional[bool] = None
change_password: Optional[datetime.datetime] = None
activated: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberInstance:
member_id: Optional[int] = None
member_type: Optional[int] = None
membership_number: Optional[str] = None
card_number: Optional[str] = None
company_name: Optional[str] = None
surname: Optional[str] = None
forenames: Optional[str] = None
title: Optional[str] = None
gender: Optional[int] = None
date_of_birth: Optional[datetime.datetime] = None
address1: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
county: Optional[str] = None
postcode: Optional[str] = None
home_phone: Optional[str] = None
mobile_phone: Optional[str] = None
email_address: Optional[str] = None
email_opt_out: Optional[bool] = None
sms_opt_out: Optional[bool] = None
phone_opt_out: Optional[bool] = None
letter_opt_out: Optional[bool] = None
direct_debit_account_holder: Optional[str] = None
direct_debit_account_number: Optional[str] = None
direct_debit_sort_code: Optional[str] = None
joined_date: Optional[datetime.datetime] = None
direct_debit_bank_address: Optional[str] = None
full_name: Optional[str] = None
external_reference: Optional[str] = None
photo: Optional[bytes] = None
photo_modified_date: Optional[datetime.datetime] = None
notes: Optional[str] = None
deleted: Optional[bool] = None
demo: Optional[bool] = None
use_external_status: Optional[bool] = None
external_status: Optional[int] = None
free_text: Optional[str] = None
member_key: Optional[str] = None
balance: Optional[Decimal] = None
credit_limit: Optional[Decimal] = None
created_date: Optional[datetime.datetime] = None
modified_date: Optional[datetime.datetime] = None
deleted_date: Optional[datetime.datetime] = None
external_source: Optional[int] = None
retention_metric: Optional[Decimal] = None
monthly_attendance_frequency: Optional[Decimal] = None
assigned_to_user_id: Optional[int] = None
created_by_user_id: Optional[int] = None
deleted_by_user_id: Optional[int] = None
loss_reason: Optional[LossReasonInstance] = None
# @References(typeof(LossReasonInstance))
loss_reason_id: Optional[int] = None
won_or_lost: Optional[int] = None
won_or_lost_date: Optional[datetime.datetime] = None
gift_aid_permission: Optional[bool] = None
photo_permission: Optional[bool] = None
first_aid_permission: Optional[bool] = None
emergency_contact: Optional[str] = None
won_or_lost_by_user: Optional[UserInstance] = None
# @References(typeof(UserInstance))
won_or_lost_by_user_id: Optional[int] = None
agreed_to_terms: Optional[datetime.datetime] = None
online_booking_banned: Optional[bool] = None
country: Optional[str] = None
fingerprint_enrolled: Optional[datetime.datetime] = None
last_payment_amount: Optional[Decimal] = None
pin: Optional[str] = None
prospecting_points: Optional[int] = None
achievement_points: Optional[int] = None
parent_forenames: Optional[str] = None
parent_surname: Optional[str] = None
# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Member")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FindMember(QueryDb[MemberInstance]):
pass
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
offset: Optional[int] = None
total: Optional[int] = None
results: Optional[List[T]] = None
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
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/Query/Member HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FindMember xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</FindMember>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfMemberInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
<d2p1:MemberInstance>
<d2p1:AchievementPoints>0</d2p1:AchievementPoints>
<d2p1:Address1>String</d2p1:Address1>
<d2p1:Address2>String</d2p1:Address2>
<d2p1:AgreedToTerms>0001-01-01T00:00:00</d2p1:AgreedToTerms>
<d2p1:AssignedToUserId>0</d2p1:AssignedToUserId>
<d2p1:Balance>0</d2p1:Balance>
<d2p1:CardNumber>String</d2p1:CardNumber>
<d2p1:City>String</d2p1:City>
<d2p1:CompanyName>String</d2p1:CompanyName>
<d2p1:Country>String</d2p1:Country>
<d2p1:County>String</d2p1:County>
<d2p1:CreatedByUserId>0</d2p1:CreatedByUserId>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:CreditLimit>0</d2p1:CreditLimit>
<d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
<d2p1:Deleted>false</d2p1:Deleted>
<d2p1:DeletedByUserId>0</d2p1:DeletedByUserId>
<d2p1:DeletedDate>0001-01-01T00:00:00</d2p1:DeletedDate>
<d2p1:Demo>false</d2p1:Demo>
<d2p1:DirectDebitAccountHolder>String</d2p1:DirectDebitAccountHolder>
<d2p1:DirectDebitAccountNumber>String</d2p1:DirectDebitAccountNumber>
<d2p1:DirectDebitBankAddress>String</d2p1:DirectDebitBankAddress>
<d2p1:DirectDebitSortCode>String</d2p1:DirectDebitSortCode>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmailOptOut>false</d2p1:EmailOptOut>
<d2p1:EmergencyContact>String</d2p1:EmergencyContact>
<d2p1:ExternalReference>String</d2p1:ExternalReference>
<d2p1:ExternalSource>0</d2p1:ExternalSource>
<d2p1:ExternalStatus>0</d2p1:ExternalStatus>
<d2p1:FingerprintEnrolled>0001-01-01T00:00:00</d2p1:FingerprintEnrolled>
<d2p1:FirstAidPermission>false</d2p1:FirstAidPermission>
<d2p1:Forenames>String</d2p1:Forenames>
<d2p1:FreeText>String</d2p1:FreeText>
<d2p1:FullName>String</d2p1:FullName>
<d2p1:Gender>0</d2p1:Gender>
<d2p1:GiftAidPermission>false</d2p1:GiftAidPermission>
<d2p1:HomePhone>String</d2p1:HomePhone>
<d2p1:JoinedDate>0001-01-01T00:00:00</d2p1:JoinedDate>
<d2p1:LastPaymentAmount>0</d2p1:LastPaymentAmount>
<d2p1:LetterOptOut>false</d2p1:LetterOptOut>
<d2p1:LossReason>
<d2p1:Deleted>false</d2p1:Deleted>
<d2p1:Demo>false</d2p1:Demo>
<d2p1:LossReasonId>0</d2p1:LossReasonId>
<d2p1:Reason>String</d2p1:Reason>
<d2p1:Selectable>false</d2p1:Selectable>
</d2p1:LossReason>
<d2p1:LossReasonId>0</d2p1:LossReasonId>
<d2p1:MemberId>0</d2p1:MemberId>
<d2p1:MemberKey>00000000-0000-0000-0000-000000000000</d2p1:MemberKey>
<d2p1:MemberType>0</d2p1:MemberType>
<d2p1:MembershipNumber>String</d2p1:MembershipNumber>
<d2p1:MobilePhone>String</d2p1:MobilePhone>
<d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
<d2p1:MonthlyAttendanceFrequency>0</d2p1:MonthlyAttendanceFrequency>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:OnlineBookingBanned>false</d2p1:OnlineBookingBanned>
<d2p1:ParentForenames>String</d2p1:ParentForenames>
<d2p1:ParentSurname>String</d2p1:ParentSurname>
<d2p1:PhoneOptOut>false</d2p1:PhoneOptOut>
<d2p1:Photo>AA==</d2p1:Photo>
<d2p1:PhotoModifiedDate>0001-01-01T00:00:00</d2p1:PhotoModifiedDate>
<d2p1:PhotoPermission>false</d2p1:PhotoPermission>
<d2p1:Pin>String</d2p1:Pin>
<d2p1:Postcode>String</d2p1:Postcode>
<d2p1:ProspectingPoints>0</d2p1:ProspectingPoints>
<d2p1:RetentionMetric>0</d2p1:RetentionMetric>
<d2p1:SmsOptOut>false</d2p1:SmsOptOut>
<d2p1:Surname>String</d2p1:Surname>
<d2p1:Title>String</d2p1:Title>
<d2p1:UseExternalStatus>false</d2p1:UseExternalStatus>
<d2p1:WonOrLost>0</d2p1:WonOrLost>
<d2p1:WonOrLostByUser>
<d2p1:Activated>0001-01-01T00:00:00</d2p1:Activated>
<d2p1:ChangePassword>0001-01-01T00:00:00</d2p1:ChangePassword>
<d2p1:CoursesCompleted>0</d2p1:CoursesCompleted>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:Deleted>false</d2p1:Deleted>
<d2p1:DisplayHomeNotification>false</d2p1:DisplayHomeNotification>
<d2p1:Email>String</d2p1:Email>
<d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
<d2p1:Enabled>false</d2p1:Enabled>
<d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
<d2p1:MobilePhone>String</d2p1:MobilePhone>
<d2p1:MobilePhoneConfirmed>false</d2p1:MobilePhoneConfirmed>
<d2p1:Name>String</d2p1:Name>
<d2p1:Notifications>false</d2p1:Notifications>
<d2p1:Training>false</d2p1:Training>
<d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
<d2p1:UserId>0</d2p1:UserId>
<d2p1:UserName>String</d2p1:UserName>
</d2p1:WonOrLostByUser>
<d2p1:WonOrLostByUserId>0</d2p1:WonOrLostByUserId>
<d2p1:WonOrLostDate>0001-01-01T00:00:00</d2p1:WonOrLostDate>
</d2p1:MemberInstance>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfMemberInstancePEZRWkv_P>