ClubManager.Api

FindMembership

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Membership

import Foundation
import ServiceStack

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Membership")
public class FindMembership : QueryDb<MembershipInstance>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class MembershipInstance : Codable
{
    public var membershipId:Int?
    public var startDate:Date?
    public var endDate:Date?
    public var contractEndDate:Date?
    public var name:String?
    public var enrolmentFee:Double?
    public var inductionFee:Double?
    public var membershipFee:Double?
    public var directDebitPayment:Double?
    public var directDebitDate:Date?
    public var member:MemberInstance?
    // @References(typeof(MemberInstance))
    public var memberId:Int?

    public var refererMemberId:Int?
    public var promotionId:Int?
    public var payment1Fee:Double?
    public var payment1Date:Date?
    public var payment2Fee:Double?
    public var payment2Date:Date?
    public var payment1Type:Int?
    public var payment1Method:Int?
    public var payment2Type:Int?
    public var payment2Method:Int?
    public var payment3Type:Int?
    public var payment3Method:Int?
    public var payment3Fee:Double?
    public var payment3Date:Date?
    public var membershipType:MembershipTypeInstance?
    // @References(typeof(MembershipTypeInstance))
    public var membershipTypeId:Int?

    public var providerId:Int?
    public var definition:String?
    public var hasRecurringPayments:Bool?
    public var deleted:Bool?
    public var demo:Bool?
    public var membershipKey:String?
    public var sessionsRemaining:Int?
    public var classesRemaining:Int?
    public var cancelled:Date?
    public var apiCreated:Date?
    public var suspensionStart:Date?
    public var suspensionEnd:Date?
    public var ipAddress:String?

    required public init(){}
}

public class MemberInstance : Codable
{
    public var memberId:Int?
    public var memberType:Int?
    public var membershipNumber:String?
    public var cardNumber:String?
    public var companyName:String?
    public var surname:String?
    public var forenames:String?
    public var title:String?
    public var gender:Int?
    public var dateOfBirth:Date?
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var county:String?
    public var postcode:String?
    public var homePhone:String?
    public var mobilePhone:String?
    public var emailAddress:String?
    public var emailOptOut:Bool?
    public var smsOptOut:Bool?
    public var phoneOptOut:Bool?
    public var letterOptOut:Bool?
    public var directDebitAccountHolder:String?
    public var directDebitAccountNumber:String?
    public var directDebitSortCode:String?
    public var joinedDate:Date?
    public var directDebitBankAddress:String?
    public var fullName:String?
    public var externalReference:String?
    public var photo:[UInt8] = []
    public var photoModifiedDate:Date?
    public var notes:String?
    public var deleted:Bool?
    public var demo:Bool?
    public var useExternalStatus:Bool?
    public var externalStatus:Int?
    public var freeText:String?
    public var memberKey:String?
    public var balance:Double?
    public var creditLimit:Double?
    public var createdDate:Date?
    public var modifiedDate:Date?
    public var deletedDate:Date?
    public var externalSource:Int?
    public var retentionMetric:Double?
    public var monthlyAttendanceFrequency:Double?
    public var assignedToUserId:Int?
    public var createdByUserId:Int?
    public var deletedByUserId:Int?
    public var lossReason:LossReasonInstance?
    // @References(typeof(LossReasonInstance))
    public var lossReasonId:Int?

    public var wonOrLost:Int?
    public var wonOrLostDate:Date?
    public var giftAidPermission:Bool?
    public var photoPermission:Bool?
    public var firstAidPermission:Bool?
    public var emergencyContact:String?
    public var wonOrLostByUser:UserInstance?
    // @References(typeof(UserInstance))
    public var wonOrLostByUserId:Int?

    public var agreedToTerms:Date?
    public var onlineBookingBanned:Bool?
    public var country:String?
    public var fingerprintEnrolled:Date?
    public var lastPaymentAmount:Double?
    public var pin:String?
    public var prospectingPoints:Int?
    public var achievementPoints:Int?
    public var parentForenames:String?
    public var parentSurname:String?

    required public init(){}
}

public class LossReasonInstance : Codable
{
    public var lossReasonId:Int?
    public var reason:String?
    public var deleted:Bool?
    public var demo:Bool?
    public var selectable:Bool?

    required public init(){}
}

public class UserInstance : Codable
{
    public var userId:Int?
    public var userName:String?
    public var name:String?
    public var email:String?
    public var mobilePhone:String?
    public var enabled:Bool?
    public var lastLogin:Date?
    public var created:Date?
    public var training:Bool?
    public var deleted:Bool?
    public var coursesCompleted:Int?
    public var displayHomeNotification:Bool?
    public var twoFactorEnabled:Bool?
    public var emailConfirmed:Bool?
    public var mobilePhoneConfirmed:Bool?
    public var notifications:Bool?
    public var changePassword:Date?
    public var activated:Date?

    required public init(){}
}

public class MembershipTypeInstance : Codable
{
    public var membershipTypeId:Int?
    public var name:String?
    public var Description:String?
    public var definition:String?
    public var schedule:ScheduleInstance?
    // @References(typeof(ScheduleInstance))
    public var scheduleId:Int?

    public var deleted:Bool?
    public var demo:Bool?
    public var `public`:Bool?
    public var sessionsRemaining:Int?
    public var classesRemaining:Int?
    public var sortOrder:Int?
    public var special:Bool?
    public var multiSiteAccess:Bool?
    public var memberLimit:Int?
    public var promotionCode:String?
    public var promotionStart:Date?
    public var promotionEnd:Date?
    public var licensesRemaining:Int?
    public var bookingAccessOnly:Bool?
    public var sessionsPeriod:Int?
    public var sessionsFrequency:Int?
    public var startsOn:Date?
    public var allowSelectionAfterStartsOn:Bool?

    required public init(){}
}

public class ScheduleInstance : Codable
{
    public var scheduleId:Int?
    public var name:String?
    public var Description:String?
    @TimeSpan public var mondayFrom:TimeInterval?
    @TimeSpan public var mondayTo:TimeInterval?
    @TimeSpan public var tuesdayFrom:TimeInterval?
    @TimeSpan public var tuesdayTo:TimeInterval?
    @TimeSpan public var wednesdayFrom:TimeInterval?
    @TimeSpan public var wednesdayTo:TimeInterval?
    @TimeSpan public var thursdayFrom:TimeInterval?
    @TimeSpan public var thursdayTo:TimeInterval?
    @TimeSpan public var fridayFrom:TimeInterval?
    @TimeSpan public var fridayTo:TimeInterval?
    @TimeSpan public var saturdayFrom:TimeInterval?
    @TimeSpan public var saturdayTo:TimeInterval?
    @TimeSpan public var sundayFrom:TimeInterval?
    @TimeSpan public var sundayTo:TimeInterval?
    public var scheduleType:Int?
    public var deleted:Bool?
    public var demo:Bool?

    required public init(){}
}

Swift FindMembership DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/Query/Membership HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindMembership 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>
</FindMembership>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfMembershipInstancePEZRWkv_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:MembershipInstance>
      <d2p1:APICreated>0001-01-01T00:00:00</d2p1:APICreated>
      <d2p1:Cancelled>0001-01-01T00:00:00</d2p1:Cancelled>
      <d2p1:ClassesRemaining>0</d2p1:ClassesRemaining>
      <d2p1:ContractEndDate>0001-01-01T00:00:00</d2p1:ContractEndDate>
      <d2p1:Definition>String</d2p1:Definition>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:Demo>false</d2p1:Demo>
      <d2p1:DirectDebitDate>0001-01-01T00:00:00</d2p1:DirectDebitDate>
      <d2p1:DirectDebitPayment>0</d2p1:DirectDebitPayment>
      <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
      <d2p1:EnrolmentFee>0</d2p1:EnrolmentFee>
      <d2p1:HasRecurringPayments>false</d2p1:HasRecurringPayments>
      <d2p1:InductionFee>0</d2p1:InductionFee>
      <d2p1:IpAddress>String</d2p1:IpAddress>
      <d2p1:Member>
        <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:Member>
      <d2p1:MemberId>0</d2p1:MemberId>
      <d2p1:MembershipFee>0</d2p1:MembershipFee>
      <d2p1:MembershipId>0</d2p1:MembershipId>
      <d2p1:MembershipKey>00000000-0000-0000-0000-000000000000</d2p1:MembershipKey>
      <d2p1:MembershipType>
        <d2p1:AllowSelectionAfterStartsOn>false</d2p1:AllowSelectionAfterStartsOn>
        <d2p1:BookingAccessOnly>false</d2p1:BookingAccessOnly>
        <d2p1:ClassesRemaining>0</d2p1:ClassesRemaining>
        <d2p1:Definition>String</d2p1:Definition>
        <d2p1:Deleted>false</d2p1:Deleted>
        <d2p1:Demo>false</d2p1:Demo>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:LicensesRemaining>0</d2p1:LicensesRemaining>
        <d2p1:MemberLimit>0</d2p1:MemberLimit>
        <d2p1:MembershipTypeId>0</d2p1:MembershipTypeId>
        <d2p1:MultiSiteAccess>false</d2p1:MultiSiteAccess>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:PromotionCode>String</d2p1:PromotionCode>
        <d2p1:PromotionEnd>0001-01-01T00:00:00</d2p1:PromotionEnd>
        <d2p1:PromotionStart>0001-01-01T00:00:00</d2p1:PromotionStart>
        <d2p1:Public>false</d2p1:Public>
        <d2p1:Schedule>
          <d2p1:Deleted>false</d2p1:Deleted>
          <d2p1:Demo>false</d2p1:Demo>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:FridayFrom>PT0S</d2p1:FridayFrom>
          <d2p1:FridayTo>PT0S</d2p1:FridayTo>
          <d2p1:MondayFrom>PT0S</d2p1:MondayFrom>
          <d2p1:MondayTo>PT0S</d2p1:MondayTo>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:SaturdayFrom>PT0S</d2p1:SaturdayFrom>
          <d2p1:SaturdayTo>PT0S</d2p1:SaturdayTo>
          <d2p1:ScheduleId>0</d2p1:ScheduleId>
          <d2p1:ScheduleType>0</d2p1:ScheduleType>
          <d2p1:SundayFrom>PT0S</d2p1:SundayFrom>
          <d2p1:SundayTo>PT0S</d2p1:SundayTo>
          <d2p1:ThursdayFrom>PT0S</d2p1:ThursdayFrom>
          <d2p1:ThursdayTo>PT0S</d2p1:ThursdayTo>
          <d2p1:TuesdayFrom>PT0S</d2p1:TuesdayFrom>
          <d2p1:TuesdayTo>PT0S</d2p1:TuesdayTo>
          <d2p1:WednesdayFrom>PT0S</d2p1:WednesdayFrom>
          <d2p1:WednesdayTo>PT0S</d2p1:WednesdayTo>
        </d2p1:Schedule>
        <d2p1:ScheduleId>0</d2p1:ScheduleId>
        <d2p1:SessionsFrequency>0</d2p1:SessionsFrequency>
        <d2p1:SessionsPeriod>0</d2p1:SessionsPeriod>
        <d2p1:SessionsRemaining>0</d2p1:SessionsRemaining>
        <d2p1:SortOrder>0</d2p1:SortOrder>
        <d2p1:Special>false</d2p1:Special>
        <d2p1:StartsOn>0001-01-01T00:00:00</d2p1:StartsOn>
      </d2p1:MembershipType>
      <d2p1:MembershipTypeId>0</d2p1:MembershipTypeId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Payment1Date>0001-01-01T00:00:00</d2p1:Payment1Date>
      <d2p1:Payment1Fee>0</d2p1:Payment1Fee>
      <d2p1:Payment1Method>0</d2p1:Payment1Method>
      <d2p1:Payment1Type>0</d2p1:Payment1Type>
      <d2p1:Payment2Date>0001-01-01T00:00:00</d2p1:Payment2Date>
      <d2p1:Payment2Fee>0</d2p1:Payment2Fee>
      <d2p1:Payment2Method>0</d2p1:Payment2Method>
      <d2p1:Payment2Type>0</d2p1:Payment2Type>
      <d2p1:Payment3Date>0001-01-01T00:00:00</d2p1:Payment3Date>
      <d2p1:Payment3Fee>0</d2p1:Payment3Fee>
      <d2p1:Payment3Method>0</d2p1:Payment3Method>
      <d2p1:Payment3Type>0</d2p1:Payment3Type>
      <d2p1:PromotionId>0</d2p1:PromotionId>
      <d2p1:ProviderId>0</d2p1:ProviderId>
      <d2p1:RefererMemberId>0</d2p1:RefererMemberId>
      <d2p1:SessionsRemaining>0</d2p1:SessionsRemaining>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:SuspensionEnd>0001-01-01T00:00:00</d2p1:SuspensionEnd>
      <d2p1:SuspensionStart>0001-01-01T00:00:00</d2p1:SuspensionStart>
    </d2p1:MembershipInstance>
  </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>
</QueryResponseOfMembershipInstancePEZRWkv_P>