GET api/ReferralsRewards?memberAccount={memberAccount}

Request Information

URI Parameters

Name	Description	Type	Additional information
memberAccount		string	Required

Body Parameters

None.

Response Information

Resource Description

Rewards

Name	Type	Additional information
CurrentBalance	decimal number	None.
AssignedCredits	decimal number	None.
RedeemCredits	decimal number	None.
CustomerDetails	CustomerDetails	None.
Referrals	Collection of ReferralInfo	None.
Tickets	Tickets	None.
History	Collection of History	None.

Response Formats

application/json, text/json

Sample:

{
  "CurrentBalance": 1.0,
  "AssignedCredits": 2.0,
  "RedeemCredits": 3.0,
  "CustomerDetails": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "TermsAndConditions": true,
    "RegionID": 1,
    "ID": "e5a46eb9-6090-49b9-9f00-802b8bdbb345",
    "ProfilePicturePath": "sample string 5",
    "IsTest": true,
    "IsDemo": true,
    "Membership": "sample string 8",
    "MemberAccount": "sample string 9",
    "TerminalID": 10
  },
  "Referrals": [
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "LeadID": "c7f8862f-9625-46df-8c68-1b6409fbc513",
      "InputDateTime": "2025-03-29T04:08:24.177922-06:00",
      "Status": "sample string 5",
      "SRCImg": "sample string 6",
      "Editable": true,
      "CreditsGenerated": [
        {
          "Credits": 1.0,
          "ExpirationDate": "2025-03-29T04:08:24.177922-06:00",
          "TransactionTypeID": 2
        },
        {
          "Credits": 1.0,
          "ExpirationDate": "2025-03-29T04:08:24.177922-06:00",
          "TransactionTypeID": 2
        }
      ]
    },
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "LeadID": "c7f8862f-9625-46df-8c68-1b6409fbc513",
      "InputDateTime": "2025-03-29T04:08:24.177922-06:00",
      "Status": "sample string 5",
      "SRCImg": "sample string 6",
      "Editable": true,
      "CreditsGenerated": [
        {
          "Credits": 1.0,
          "ExpirationDate": "2025-03-29T04:08:24.177922-06:00",
          "TransactionTypeID": 2
        },
        {
          "Credits": 1.0,
          "ExpirationDate": "2025-03-29T04:08:24.177922-06:00",
          "TransactionTypeID": 2
        }
      ]
    }
  ],
  "Tickets": {
    "Referrals": 1,
    "Certificates": 2,
    "Detail": [
      {
        "TicketTransactionTypeID": 64,
        "TicketID": "sample string 2",
        "DateSaved": "2025-03-29T04:08:24.177922-06:00"
      },
      {
        "TicketTransactionTypeID": 64,
        "TicketID": "sample string 2",
        "DateSaved": "2025-03-29T04:08:24.177922-06:00"
      }
    ]
  },
  "History": [
    {
      "ActiveCredits": 1.0,
      "StatusCode": 2,
      "Balance": 1.0,
      "ExpiratedCredits": 1.0,
      "PlaceID": 1,
      "CreditsID": "e17ca028-ec10-42ee-9cdd-8089f2ca25a6",
      "Credits": 4.0,
      "Concept": "sample string 5",
      "ExpirationDate": "2025-03-29T04:08:24.177922-06:00",
      "TransactionTypeID": 6,
      "GeneratedDate": "2025-03-29T04:08:24.177922-06:00",
      "IsRedeem": true,
      "TerminalID": 9,
      "SPIRegion": "sample string 10",
      "SPIRegionID": 1,
      "Place": "sample string 11",
      "Reference": "sample string 12",
      "CreditsFactor": 1.0,
      "MemberNumber": "sample string 13"
    },
    {
      "ActiveCredits": 1.0,
      "StatusCode": 2,
      "Balance": 1.0,
      "ExpiratedCredits": 1.0,
      "PlaceID": 1,
      "CreditsID": "e17ca028-ec10-42ee-9cdd-8089f2ca25a6",
      "Credits": 4.0,
      "Concept": "sample string 5",
      "ExpirationDate": "2025-03-29T04:08:24.177922-06:00",
      "TransactionTypeID": 6,
      "GeneratedDate": "2025-03-29T04:08:24.177922-06:00",
      "IsRedeem": true,
      "TerminalID": 9,
      "SPIRegion": "sample string 10",
      "SPIRegionID": 1,
      "Place": "sample string 11",
      "Reference": "sample string 12",
      "CreditsFactor": 1.0,
      "MemberNumber": "sample string 13"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiReferralsViewModel.Rewards xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.ViewModels">
  <AssignedCredits>2</AssignedCredits>
  <CurrentBalance>1</CurrentBalance>
  <CustomerDetails>
    <FirstName>sample string 1</FirstName>
    <ID>e5a46eb9-6090-49b9-9f00-802b8bdbb345</ID>
    <IsDemo>true</IsDemo>
    <IsTest>true</IsTest>
    <LastName>sample string 2</LastName>
    <MemberAccount>sample string 9</MemberAccount>
    <Membership>sample string 8</Membership>
    <ProfilePicturePath>sample string 5</ProfilePicturePath>
    <RegionID>1</RegionID>
    <TerminalID>10</TerminalID>
    <TermsAndConditions>true</TermsAndConditions>
  </CustomerDetails>
  <History>
    <ReferralViewModel.History>
      <ActiveCredits>1</ActiveCredits>
      <Balance>1</Balance>
      <Concept>sample string 5</Concept>
      <Credits>4</Credits>
      <CreditsFactor>1</CreditsFactor>
      <CreditsID>e17ca028-ec10-42ee-9cdd-8089f2ca25a6</CreditsID>
      <ExpiratedCredits>1</ExpiratedCredits>
      <ExpirationDate>2025-03-29T04:08:24.177922-06:00</ExpirationDate>
      <GeneratedDate>2025-03-29T04:08:24.177922-06:00</GeneratedDate>
      <IsRedeem>true</IsRedeem>
      <MemberNumber>sample string 13</MemberNumber>
      <Place>sample string 11</Place>
      <PlaceID>1</PlaceID>
      <Reference>sample string 12</Reference>
      <SPIRegion>sample string 10</SPIRegion>
      <SPIRegionID>1</SPIRegionID>
      <StatusCode>2</StatusCode>
      <TerminalID>9</TerminalID>
      <TransactionTypeID>6</TransactionTypeID>
    </ReferralViewModel.History>
    <ReferralViewModel.History>
      <ActiveCredits>1</ActiveCredits>
      <Balance>1</Balance>
      <Concept>sample string 5</Concept>
      <Credits>4</Credits>
      <CreditsFactor>1</CreditsFactor>
      <CreditsID>e17ca028-ec10-42ee-9cdd-8089f2ca25a6</CreditsID>
      <ExpiratedCredits>1</ExpiratedCredits>
      <ExpirationDate>2025-03-29T04:08:24.177922-06:00</ExpirationDate>
      <GeneratedDate>2025-03-29T04:08:24.177922-06:00</GeneratedDate>
      <IsRedeem>true</IsRedeem>
      <MemberNumber>sample string 13</MemberNumber>
      <Place>sample string 11</Place>
      <PlaceID>1</PlaceID>
      <Reference>sample string 12</Reference>
      <SPIRegion>sample string 10</SPIRegion>
      <SPIRegionID>1</SPIRegionID>
      <StatusCode>2</StatusCode>
      <TerminalID>9</TerminalID>
      <TransactionTypeID>6</TransactionTypeID>
    </ReferralViewModel.History>
  </History>
  <RedeemCredits>3</RedeemCredits>
  <Referrals>
    <ApiReferralsViewModel.ReferralInfo>
      <CreditsGenerated>
        <ApiReferralsViewModel.CreditsInfo>
          <Credits>1</Credits>
          <ExpirationDate>2025-03-29T04:08:24.177922-06:00</ExpirationDate>
          <TransactionTypeID>2</TransactionTypeID>
        </ApiReferralsViewModel.CreditsInfo>
        <ApiReferralsViewModel.CreditsInfo>
          <Credits>1</Credits>
          <ExpirationDate>2025-03-29T04:08:24.177922-06:00</ExpirationDate>
          <TransactionTypeID>2</TransactionTypeID>
        </ApiReferralsViewModel.CreditsInfo>
      </CreditsGenerated>
      <Editable>true</Editable>
      <FirstName>sample string 1</FirstName>
      <InputDateTime>2025-03-29T04:08:24.177922-06:00</InputDateTime>
      <LastName>sample string 2</LastName>
      <LeadID>c7f8862f-9625-46df-8c68-1b6409fbc513</LeadID>
      <SRCImg>sample string 6</SRCImg>
      <Status>sample string 5</Status>
    </ApiReferralsViewModel.ReferralInfo>
    <ApiReferralsViewModel.ReferralInfo>
      <CreditsGenerated>
        <ApiReferralsViewModel.CreditsInfo>
          <Credits>1</Credits>
          <ExpirationDate>2025-03-29T04:08:24.177922-06:00</ExpirationDate>
          <TransactionTypeID>2</TransactionTypeID>
        </ApiReferralsViewModel.CreditsInfo>
        <ApiReferralsViewModel.CreditsInfo>
          <Credits>1</Credits>
          <ExpirationDate>2025-03-29T04:08:24.177922-06:00</ExpirationDate>
          <TransactionTypeID>2</TransactionTypeID>
        </ApiReferralsViewModel.CreditsInfo>
      </CreditsGenerated>
      <Editable>true</Editable>
      <FirstName>sample string 1</FirstName>
      <InputDateTime>2025-03-29T04:08:24.177922-06:00</InputDateTime>
      <LastName>sample string 2</LastName>
      <LeadID>c7f8862f-9625-46df-8c68-1b6409fbc513</LeadID>
      <SRCImg>sample string 6</SRCImg>
      <Status>sample string 5</Status>
    </ApiReferralsViewModel.ReferralInfo>
  </Referrals>
  <Tickets>
    <Certificates>2</Certificates>
    <Detail>
      <ApiReferralsViewModel.Tickets.TicketsDetail>
        <DateSaved>2025-03-29T04:08:24.177922-06:00</DateSaved>
        <TicketID>sample string 2</TicketID>
        <TicketTransactionTypeID>64</TicketTransactionTypeID>
      </ApiReferralsViewModel.Tickets.TicketsDetail>
      <ApiReferralsViewModel.Tickets.TicketsDetail>
        <DateSaved>2025-03-29T04:08:24.177922-06:00</DateSaved>
        <TicketID>sample string 2</TicketID>
        <TicketTransactionTypeID>64</TicketTransactionTypeID>
      </ApiReferralsViewModel.Tickets.TicketsDetail>
    </Detail>
    <Referrals>1</Referrals>
  </Tickets>
</ApiReferralsViewModel.Rewards>