GET api/members/activemembership/{cfid}

Request Information

URI Parameters

Name	Description	Type	Additional information
cfid		integer	Required

Body Parameters

None.

Response Information

Resource Description

ActiveMembership

Name	Type	Additional information
FolderId	integer	None.
MemberId	integer	None.
FolderProductId	integer	None.
MembershipId	integer	None.
Description	string	None.
PhotoUrl	string	None.
StartDate	date	None.
EndDate	date	None.
RemainingDays	integer	None.
LastAppearanceDate	date	None.
LastBenefitUsageDate	date	None.
RecentActivityCount	integer	None.
RecentActivityPeriodDays	integer	None.
UsageStatus	MembershipUsageStatus	None.
CheckInStatus	CFCheckInStatus	None.
DefaultCheckInTreatment	MembershipTreatment	None.
LimitedBenefits	Collection of MembershipBenefit	None.
UnlimitedTreatments	Collection of MembershipTreatment	None.

Response Formats

application/json, text/json

Sample:

{
  "FolderId": 1,
  "MemberId": 2,
  "FolderProductId": 3,
  "MembershipId": 4,
  "Description": "sample string 5",
  "PhotoUrl": "sample string 6",
  "StartDate": "2026-08-18T04:41:07.7608758+03:00",
  "EndDate": "2026-08-18T04:41:07.7608758+03:00",
  "RemainingDays": 9,
  "LastAppearanceDate": "2026-08-18T04:41:07.7608758+03:00",
  "LastBenefitUsageDate": "2026-08-18T04:41:07.7608758+03:00",
  "RecentActivityCount": 10,
  "RecentActivityPeriodDays": 11,
  "UsageStatus": 0,
  "CheckInStatus": 0,
  "DefaultCheckInTreatment": {
    "TreatmentId": 1,
    "Description": "sample string 2"
  },
  "LimitedBenefits": [
    {
      "Total": 1,
      "Remaining": 2,
      "Scheduled": 3,
      "Consumed": 4,
      "TreatmentId": 5,
      "Description": "sample string 6"
    },
    {
      "Total": 1,
      "Remaining": 2,
      "Scheduled": 3,
      "Consumed": 4,
      "TreatmentId": 5,
      "Description": "sample string 6"
    }
  ],
  "UnlimitedTreatments": [
    {
      "TreatmentId": 1,
      "Description": "sample string 2"
    },
    {
      "TreatmentId": 1,
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ActiveMembership xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Web.Api.Models">
  <CheckInStatus>NotCheckedIn</CheckInStatus>
  <DefaultCheckInTreatment>
    <Description>sample string 2</Description>
    <TreatmentId>1</TreatmentId>
  </DefaultCheckInTreatment>
  <Description>sample string 5</Description>
  <EndDate>2026-08-18T04:41:07.7608758+03:00</EndDate>
  <FolderId>1</FolderId>
  <FolderProductId>3</FolderProductId>
  <LastAppearanceDate>2026-08-18T04:41:07.7608758+03:00</LastAppearanceDate>
  <LastBenefitUsageDate>2026-08-18T04:41:07.7608758+03:00</LastBenefitUsageDate>
  <LimitedBenefits>
    <MembershipBenefit>
      <Description>sample string 6</Description>
      <TreatmentId>5</TreatmentId>
      <Consumed>4</Consumed>
      <Remaining>2</Remaining>
      <Scheduled>3</Scheduled>
      <Total>1</Total>
    </MembershipBenefit>
    <MembershipBenefit>
      <Description>sample string 6</Description>
      <TreatmentId>5</TreatmentId>
      <Consumed>4</Consumed>
      <Remaining>2</Remaining>
      <Scheduled>3</Scheduled>
      <Total>1</Total>
    </MembershipBenefit>
  </LimitedBenefits>
  <MemberId>2</MemberId>
  <MembershipId>4</MembershipId>
  <PhotoUrl>sample string 6</PhotoUrl>
  <RecentActivityCount>10</RecentActivityCount>
  <RecentActivityPeriodDays>11</RecentActivityPeriodDays>
  <RemainingDays>9</RemainingDays>
  <StartDate>2026-08-18T04:41:07.7608758+03:00</StartDate>
  <UnlimitedTreatments>
    <MembershipTreatment>
      <Description>sample string 2</Description>
      <TreatmentId>1</TreatmentId>
    </MembershipTreatment>
    <MembershipTreatment>
      <Description>sample string 2</Description>
      <TreatmentId>1</TreatmentId>
    </MembershipTreatment>
  </UnlimitedTreatments>
  <UsageStatus>Absent</UsageStatus>
</ActiveMembership>