| Required role: | API |
| All Verbs | /api/Query/Membership |
|---|
namespace ClubManager.Api.Services.Query
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type LossReasonInstance() =
member val LossReasonId:Int32 = new Int32() with get,set
member val Reason:String = null with get,set
member val Deleted:Boolean = new Boolean() with get,set
member val Demo:Boolean = new Boolean() with get,set
member val Selectable:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type UserInstance() =
member val UserId:Int32 = new Int32() with get,set
member val UserName:String = null with get,set
member val Name:String = null with get,set
member val Email:String = null with get,set
member val MobilePhone:String = null with get,set
member val Enabled:Boolean = new Boolean() with get,set
member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Created:DateTime = new DateTime() with get,set
member val Training:Boolean = new Boolean() with get,set
member val Deleted:Boolean = new Boolean() with get,set
member val CoursesCompleted:Int32 = new Int32() with get,set
member val DisplayHomeNotification:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val TwoFactorEnabled:Boolean = new Boolean() with get,set
member val EmailConfirmed:Boolean = new Boolean() with get,set
member val MobilePhoneConfirmed:Boolean = new Boolean() with get,set
member val Notifications:Boolean = new Boolean() with get,set
member val ChangePassword:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Activated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type MemberInstance() =
member val MemberId:Int32 = new Int32() with get,set
member val MemberType:Int32 = new Int32() with get,set
member val MembershipNumber:String = null with get,set
member val CardNumber:String = null with get,set
member val CompanyName:String = null with get,set
member val Surname:String = null with get,set
member val Forenames:String = null with get,set
member val Title:String = null with get,set
member val Gender:Int32 = new Int32() with get,set
member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Address1:String = null with get,set
member val Address2:String = null with get,set
member val City:String = null with get,set
member val County:String = null with get,set
member val Postcode: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 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 DirectDebitAccountHolder:String = null with get,set
member val DirectDebitAccountNumber:String = null with get,set
member val DirectDebitSortCode:String = null with get,set
member val JoinedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DirectDebitBankAddress:String = null with get,set
member val FullName:String = null with get,set
member val ExternalReference:String = null with get,set
member val Photo:Byte[] = [||] with get,set
member val PhotoModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Notes:String = null with get,set
member val Deleted:Boolean = new Boolean() with get,set
member val Demo:Boolean = new Boolean() with get,set
member val UseExternalStatus:Boolean = new Boolean() with get,set
member val ExternalStatus:Int32 = new Int32() with get,set
member val FreeText:String = null with get,set
member val MemberKey:Nullable<Guid> = new Nullable<Guid>() with get,set
member val Balance:Decimal = new Decimal() with get,set
member val CreditLimit:Decimal = new Decimal() with get,set
member val CreatedDate:DateTime = new 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 ExternalSource:Int32 = new Int32() with get,set
member val RetentionMetric:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val MonthlyAttendanceFrequency:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val AssignedToUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val CreatedByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val DeletedByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val LossReason:LossReasonInstance = null with get,set
[<References(typeof<LossReasonInstance>)>]
member val LossReasonId:Nullable<Int32> = new Nullable<Int32>() 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 GiftAidPermission:Boolean = new Boolean() with get,set
member val PhotoPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val FirstAidPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val EmergencyContact:String = null with get,set
member val WonOrLostByUser:UserInstance = null with get,set
[<References(typeof<UserInstance>)>]
member val WonOrLostByUserId:Nullable<Int32> = new Nullable<Int32>() 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 Country:String = null with get,set
member val FingerprintEnrolled:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LastPaymentAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Pin: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
[<AllowNullLiteral>]
type ScheduleInstance() =
member val ScheduleId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
member val MondayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val MondayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val TuesdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val TuesdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val WednesdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val WednesdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val ThursdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val ThursdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val FridayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val FridayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val SaturdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val SaturdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val SundayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val SundayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val ScheduleType:Int32 = new Int32() with get,set
member val Deleted:Boolean = new Boolean() with get,set
member val Demo:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type MembershipTypeInstance() =
member val MembershipTypeId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
member val Definition:String = null with get,set
member val Schedule:ScheduleInstance = null with get,set
[<References(typeof<ScheduleInstance>)>]
member val ScheduleId:Int32 = new Int32() with get,set
member val Deleted:Boolean = new Boolean() with get,set
member val Demo:Boolean = new Boolean() with get,set
member val Public:Boolean = new Boolean() with get,set
member val SessionsRemaining:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ClassesRemaining:Nullable<Int32> = new Nullable<Int32>() with get,set
member val SortOrder:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Special:Boolean = new Boolean() with get,set
member val MultiSiteAccess:Boolean = new Boolean() with get,set
member val MemberLimit:Int32 = new Int32() with get,set
member val PromotionCode:String = null with get,set
member val PromotionStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val PromotionEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LicensesRemaining:Nullable<Int32> = new Nullable<Int32>() with get,set
member val BookingAccessOnly:Boolean = new Boolean() with get,set
member val SessionsPeriod:Nullable<Int32> = new Nullable<Int32>() with get,set
member val SessionsFrequency:Nullable<Int32> = new Nullable<Int32>() with get,set
member val StartsOn:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val AllowSelectionAfterStartsOn:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type MembershipInstance() =
member val MembershipId:Int32 = new Int32() with get,set
member val StartDate:DateTime = new DateTime() with get,set
member val EndDate:DateTime = new DateTime() with get,set
member val ContractEndDate:DateTime = new DateTime() with get,set
member val Name:String = null with get,set
member val EnrolmentFee:Decimal = new Decimal() with get,set
member val InductionFee:Decimal = new Decimal() with get,set
member val MembershipFee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val DirectDebitPayment:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val DirectDebitDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Member:MemberInstance = null with get,set
[<References(typeof<MemberInstance>)>]
member val MemberId:Int32 = new Int32() with get,set
member val RefererMemberId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val PromotionId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Payment1Fee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Payment1Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Payment2Fee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Payment2Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Payment1Type:Int32 = new Int32() with get,set
member val Payment1Method:Int32 = new Int32() with get,set
member val Payment2Type:Int32 = new Int32() with get,set
member val Payment2Method:Int32 = new Int32() with get,set
member val Payment3Type:Int32 = new Int32() with get,set
member val Payment3Method:Int32 = new Int32() with get,set
member val Payment3Fee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Payment3Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val MembershipType:MembershipTypeInstance = null with get,set
[<References(typeof<MembershipTypeInstance>)>]
member val MembershipTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ProviderId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Definition:String = null with get,set
member val HasRecurringPayments:Boolean = new Boolean() with get,set
member val Deleted:Boolean = new Boolean() with get,set
member val Demo:Boolean = new Boolean() with get,set
member val MembershipKey:Nullable<Guid> = new Nullable<Guid>() with get,set
member val SessionsRemaining:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ClassesRemaining:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Cancelled:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val APICreated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SuspensionStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SuspensionEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val IpAddress:String = null with get,set
[<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Membership")>]
[<AllowNullLiteral>]
type FindMembership() =
inherit QueryDb<MembershipInstance>()
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<'T>() =
inherit QueryBase()
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<'T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<'T> = new ResizeArray<'T>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
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/Query/Membership HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Skip: 0,
Take: 0,
OrderBy: String,
OrderByDesc: String,
Include: String,
Fields: String,
Meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
MembershipId: 0,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
ContractEndDate: 0001-01-01,
Name: String,
EnrolmentFee: 0,
InductionFee: 0,
MembershipFee: 0,
DirectDebitPayment: 0,
DirectDebitDate: 0001-01-01,
Member:
{
MemberId: 0,
MemberType: 0,
MembershipNumber: String,
CardNumber: String,
CompanyName: String,
Surname: String,
Forenames: String,
Title: String,
Gender: 0,
DateOfBirth: 0001-01-01,
Address1: String,
Address2: String,
City: String,
County: String,
Postcode: String,
HomePhone: String,
MobilePhone: String,
EmailAddress: String,
EmailOptOut: False,
SmsOptOut: False,
PhoneOptOut: False,
LetterOptOut: False,
DirectDebitAccountHolder: String,
DirectDebitAccountNumber: String,
DirectDebitSortCode: String,
JoinedDate: 0001-01-01,
DirectDebitBankAddress: String,
FullName: String,
ExternalReference: String,
Photo: AA==,
PhotoModifiedDate: 0001-01-01,
Notes: String,
Deleted: False,
Demo: False,
UseExternalStatus: False,
ExternalStatus: 0,
FreeText: String,
MemberKey: 00000000000000000000000000000000,
Balance: 0,
CreditLimit: 0,
CreatedDate: 0001-01-01,
ModifiedDate: 0001-01-01,
DeletedDate: 0001-01-01,
ExternalSource: 0,
RetentionMetric: 0,
MonthlyAttendanceFrequency: 0,
AssignedToUserId: 0,
CreatedByUserId: 0,
DeletedByUserId: 0,
LossReason:
{
LossReasonId: 0,
Reason: String,
Deleted: False,
Demo: False,
Selectable: False
},
LossReasonId: 0,
WonOrLost: 0,
WonOrLostDate: 0001-01-01,
GiftAidPermission: False,
PhotoPermission: False,
FirstAidPermission: False,
EmergencyContact: String,
WonOrLostByUser:
{
UserId: 0,
UserName: String,
Name: String,
Email: String,
MobilePhone: String,
Enabled: False,
LastLogin: 0001-01-01,
Created: 0001-01-01,
Training: False,
Deleted: False,
CoursesCompleted: 0,
DisplayHomeNotification: False,
TwoFactorEnabled: False,
EmailConfirmed: False,
MobilePhoneConfirmed: False,
Notifications: False,
ChangePassword: 0001-01-01,
Activated: 0001-01-01
},
WonOrLostByUserId: 0,
AgreedToTerms: 0001-01-01,
OnlineBookingBanned: False,
Country: String,
FingerprintEnrolled: 0001-01-01,
LastPaymentAmount: 0,
Pin: String,
ProspectingPoints: 0,
AchievementPoints: 0,
ParentForenames: String,
ParentSurname: String
},
MemberId: 0,
RefererMemberId: 0,
PromotionId: 0,
Payment1Fee: 0,
Payment1Date: 0001-01-01,
Payment2Fee: 0,
Payment2Date: 0001-01-01,
Payment1Type: 0,
Payment1Method: 0,
Payment2Type: 0,
Payment2Method: 0,
Payment3Type: 0,
Payment3Method: 0,
Payment3Fee: 0,
Payment3Date: 0001-01-01,
MembershipType:
{
MembershipTypeId: 0,
Name: String,
Description: String,
Definition: String,
Schedule:
{
ScheduleId: 0,
Name: String,
Description: String,
MondayFrom: PT0S,
MondayTo: PT0S,
TuesdayFrom: PT0S,
TuesdayTo: PT0S,
WednesdayFrom: PT0S,
WednesdayTo: PT0S,
ThursdayFrom: PT0S,
ThursdayTo: PT0S,
FridayFrom: PT0S,
FridayTo: PT0S,
SaturdayFrom: PT0S,
SaturdayTo: PT0S,
SundayFrom: PT0S,
SundayTo: PT0S,
ScheduleType: 0,
Deleted: False,
Demo: False
},
ScheduleId: 0,
Deleted: False,
Demo: False,
Public: False,
SessionsRemaining: 0,
ClassesRemaining: 0,
SortOrder: 0,
Special: False,
MultiSiteAccess: False,
MemberLimit: 0,
PromotionCode: String,
PromotionStart: 0001-01-01,
PromotionEnd: 0001-01-01,
LicensesRemaining: 0,
BookingAccessOnly: False,
SessionsPeriod: 0,
SessionsFrequency: 0,
StartsOn: 0001-01-01,
AllowSelectionAfterStartsOn: False
},
MembershipTypeId: 0,
ProviderId: 0,
Definition: String,
HasRecurringPayments: False,
Deleted: False,
Demo: False,
MembershipKey: 00000000000000000000000000000000,
SessionsRemaining: 0,
ClassesRemaining: 0,
Cancelled: 0001-01-01,
APICreated: 0001-01-01,
SuspensionStart: 0001-01-01,
SuspensionEnd: 0001-01-01,
IpAddress: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}