ClubManager.Api

FindMembershipType

**Requires Authentication**
Required role:	API

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

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

    [<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MembershipType")>]
    [<AllowNullLiteral>]
    type FindMembershipType() = 
        inherit QueryDb<MembershipTypeInstance>()

    [<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

F# FindMembershipType 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/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>