| Required role: | API |
| All Verbs | /api/Query/MembershipType |
|---|
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 ScheduleInstance:
schedule_id: Optional[int] = None
name: Optional[str] = None
description: Optional[str] = None
monday_from: Optional[datetime.timedelta] = None
monday_to: Optional[datetime.timedelta] = None
tuesday_from: Optional[datetime.timedelta] = None
tuesday_to: Optional[datetime.timedelta] = None
wednesday_from: Optional[datetime.timedelta] = None
wednesday_to: Optional[datetime.timedelta] = None
thursday_from: Optional[datetime.timedelta] = None
thursday_to: Optional[datetime.timedelta] = None
friday_from: Optional[datetime.timedelta] = None
friday_to: Optional[datetime.timedelta] = None
saturday_from: Optional[datetime.timedelta] = None
saturday_to: Optional[datetime.timedelta] = None
sunday_from: Optional[datetime.timedelta] = None
sunday_to: Optional[datetime.timedelta] = None
schedule_type: Optional[int] = None
deleted: Optional[bool] = None
demo: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MembershipTypeInstance:
membership_type_id: Optional[int] = None
name: Optional[str] = None
description: Optional[str] = None
definition: Optional[str] = None
schedule: Optional[ScheduleInstance] = None
# @References(typeof(ScheduleInstance))
schedule_id: Optional[int] = None
deleted: Optional[bool] = None
demo: Optional[bool] = None
public: Optional[bool] = None
sessions_remaining: Optional[int] = None
classes_remaining: Optional[int] = None
sort_order: Optional[int] = None
special: Optional[bool] = None
multi_site_access: Optional[bool] = None
member_limit: Optional[int] = None
promotion_code: Optional[str] = None
promotion_start: Optional[datetime.datetime] = None
promotion_end: Optional[datetime.datetime] = None
licenses_remaining: Optional[int] = None
booking_access_only: Optional[bool] = None
sessions_period: Optional[int] = None
sessions_frequency: Optional[int] = None
starts_on: Optional[datetime.datetime] = None
allow_selection_after_starts_on: Optional[bool] = None
# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MembershipType")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FindMembershipType(QueryDb[MembershipTypeInstance]):
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
Python 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>