ClubReady Api

<back to all web services

GetMembershipTypesRequest

The following routes are available for this service:
GET/club/membership-typesList of membership types.
GetMembershipTypesRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoEither StoreId or ChainId is required
StoreIdqueryintegerNoEither StoreId or ChainId is required
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
GetMembershipTypesResponse Parameters:
NameParameterData TypeRequiredDescription
MembershipTypesformList<ApiGenericType>No
GetMembershipTypesResponseDto Parameters:
NameParameterData TypeRequiredDescription
MembershipTypesformList<ApiGenericType>No
ApiGenericType Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
StoreIdformint?No
ChainIdformint?No

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: www.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>