ClubReady Api

<back to all web services

GetMembershipTypesRequest

The following routes are available for this service:
GET/club/membership-typesList of membership types.
namespace ClubReady.Core.Api.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type GetMembershipTypesRequest() = 
        inherit ApiDtoBase()
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")>]
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set

    [<AllowNullLiteral>]
    type ApiGenericType() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type GetMembershipTypesResponseDto() = 
        member val MembershipTypes:ResizeArray<ApiGenericType> = new ResizeArray<ApiGenericType>() with get,set

    [<AllowNullLiteral>]
    type GetMembershipTypesResponse() = 
        inherit GetMembershipTypesResponseDto()
        member val MembershipTypes:ResizeArray<ApiGenericType> = new ResizeArray<ApiGenericType>() with get,set

F# GetMembershipTypesRequest 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.

GET /club/membership-types HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<GetMembershipTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Club.Models">
  <MembershipTypes xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <ApiGenericType>
      <ChainId>0</ChainId>
      <Id>0</Id>
      <Name>String</Name>
      <StoreId>0</StoreId>
    </ApiGenericType>
  </MembershipTypes>
</GetMembershipTypesResponse>