| Required role: | API |
| All Verbs | /api/Query/MembershipType |
|---|
// @DataContract
export class QueryBase
{
// @DataMember(Order=1)
public Skip?: number;
// @DataMember(Order=2)
public Take?: number;
// @DataMember(Order=3)
public OrderBy?: string;
// @DataMember(Order=4)
public OrderByDesc?: string;
// @DataMember(Order=5)
public Include?: string;
// @DataMember(Order=6)
public Fields?: string;
// @DataMember(Order=7)
public Meta?: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<T> extends QueryBase
{
public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}
export class ScheduleInstance
{
public ScheduleId?: number;
public Name?: string;
public Description?: string;
public MondayFrom?: string;
public MondayTo?: string;
public TuesdayFrom?: string;
public TuesdayTo?: string;
public WednesdayFrom?: string;
public WednesdayTo?: string;
public ThursdayFrom?: string;
public ThursdayTo?: string;
public FridayFrom?: string;
public FridayTo?: string;
public SaturdayFrom?: string;
public SaturdayTo?: string;
public SundayFrom?: string;
public SundayTo?: string;
public ScheduleType?: number;
public Deleted?: boolean;
public Demo?: boolean;
public constructor(init?: Partial<ScheduleInstance>) { (Object as any).assign(this, init); }
}
export class MembershipTypeInstance
{
public MembershipTypeId?: number;
public Name?: string;
public Description?: string;
public Definition?: string;
public Schedule?: ScheduleInstance;
// @References("typeof(ClubManager.Api.Services.Query.ScheduleInstance)")
public ScheduleId?: number;
public Deleted?: boolean;
public Demo?: boolean;
public Public?: boolean;
public SessionsRemaining?: number;
public ClassesRemaining?: number;
public SortOrder?: number;
public Special?: boolean;
public MultiSiteAccess?: boolean;
public MemberLimit?: number;
public PromotionCode?: string;
public PromotionStart?: string;
public PromotionEnd?: string;
public LicensesRemaining?: number;
public BookingAccessOnly?: boolean;
public SessionsPeriod?: number;
public SessionsFrequency?: number;
public StartsOn?: string;
public AllowSelectionAfterStartsOn?: boolean;
public constructor(init?: Partial<MembershipTypeInstance>) { (Object as any).assign(this, init); }
}
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MembershipType")
export class FindMembershipType extends QueryDb<MembershipTypeInstance>
{
public constructor(init?: Partial<FindMembershipType>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<T>
{
// @DataMember(Order=1)
public Offset?: number;
// @DataMember(Order=2)
public Total?: number;
// @DataMember(Order=3)
public Results?: T[];
// @DataMember(Order=4)
public Meta?: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus?: ResponseStatus;
public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}
TypeScript FindMembershipType DTOs
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/MembershipType HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FindMembershipType 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>
</FindMembershipType>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfMembershipTypeInstancePEZRWkv_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:MembershipTypeInstance>
<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:MembershipTypeInstance>
</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>
</QueryResponseOfMembershipTypeInstancePEZRWkv_P>