GET api/loyalty2/member/shop/{shopId}/page/{page}/size/{pageSize}/term/{searchTerm}

Provides member(s) of a club as PAGED, given page, size, search term and shop id. The search is run against the properties of a member. It's possible to have a concatenated search term, containing multiple property-values of a member, seperated by space (' '). Properties can be omitted, but in case of multiple values they must be present in the order CustomerNumber, FirstName, LastName, Address, PostalCode, City, Country ,Phone, Email.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopId

The id of the shop.

integer

Required

searchTerm

The search term.

string

Required

page

The current page.

integer

Required

pageSize

The size of the page.

integer

Required

Body Parameters

None.

Response Information

Resource Description

PagedSearchResultMembers
NameDescriptionTypeAdditional information
PageNumber

The number of this page.

integer

None.

PageSize

The size of this page.

integer

None.

TotalNumberOfPages

The total number of pages available.

integer

None.

TotalNumberOfRecords

The total number of records available.

integer

None.

Results

The results of this page.

Collection of MemberSearchResult

None.

AverageRank

The averang rank of this page.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "PageNumber": 1,
  "PageSize": 2,
  "TotalNumberOfPages": 3,
  "TotalNumberOfRecords": 4,
  "Results": [
    {
      "Id": 1,
      "CustomerNumber": 2,
      "CreationShop": "sample string 3",
      "User": "sample string 4",
      "Password": "sample string 5",
      "Modified": "2025-05-04T06:53:05.4775255+02:00",
      "IsDeleted": true,
      "RANK": 7,
      "DiscountPoints": 8.0,
      "DiscountMoney": 9.0,
      "BonusPoints": 10.0,
      "BonusMoney": 11.0,
      "ClubId": 12,
      "EngineId": 13,
      "FirstName": "sample string 14",
      "LastName": "sample string 15",
      "Address": "sample string 16",
      "PostalCode": "sample string 17",
      "City": "sample string 18",
      "Country": "sample string 19",
      "Gender": "sample string 20",
      "BirthDate": "2025-05-04T06:53:05.4775255+02:00",
      "Email": "sample string 21",
      "Phone": "sample string 22",
      "ReceiptByEmail": 23,
      "Notes": "sample string 24",
      "IsActive": true,
      "Created": "2025-05-04T06:53:05.4775255+02:00",
      "SignedUp": "2025-05-04T06:53:05.4775255+02:00",
      "DefaultShop": 1,
      "SocialSecurityNr": "sample string 25",
      "TermsConditionsApproved": true
    },
    {
      "Id": 1,
      "CustomerNumber": 2,
      "CreationShop": "sample string 3",
      "User": "sample string 4",
      "Password": "sample string 5",
      "Modified": "2025-05-04T06:53:05.4775255+02:00",
      "IsDeleted": true,
      "RANK": 7,
      "DiscountPoints": 8.0,
      "DiscountMoney": 9.0,
      "BonusPoints": 10.0,
      "BonusMoney": 11.0,
      "ClubId": 12,
      "EngineId": 13,
      "FirstName": "sample string 14",
      "LastName": "sample string 15",
      "Address": "sample string 16",
      "PostalCode": "sample string 17",
      "City": "sample string 18",
      "Country": "sample string 19",
      "Gender": "sample string 20",
      "BirthDate": "2025-05-04T06:53:05.4775255+02:00",
      "Email": "sample string 21",
      "Phone": "sample string 22",
      "ReceiptByEmail": 23,
      "Notes": "sample string 24",
      "IsActive": true,
      "Created": "2025-05-04T06:53:05.4775255+02:00",
      "SignedUp": "2025-05-04T06:53:05.4775255+02:00",
      "DefaultShop": 1,
      "SocialSecurityNr": "sample string 25",
      "TermsConditionsApproved": true
    }
  ],
  "AverageRank": 5
}

application/xml, text/xml

Sample:
<PagedSearchResultMembersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <AverageRank>5</AverageRank>
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
  <Results>
    <MemberSearchResultViewModel>
      <Address>sample string 16</Address>
      <BirthDate>2025-05-04T06:53:05.4775255+02:00</BirthDate>
      <City>sample string 18</City>
      <ClubId>12</ClubId>
      <Country>sample string 19</Country>
      <Created>2025-05-04T06:53:05.4775255+02:00</Created>
      <DefaultShop>1</DefaultShop>
      <Email>sample string 21</Email>
      <EngineId>13</EngineId>
      <FirstName>sample string 14</FirstName>
      <Gender>sample string 20</Gender>
      <IsActive>true</IsActive>
      <LastName>sample string 15</LastName>
      <Notes>sample string 24</Notes>
      <Phone>sample string 22</Phone>
      <PostalCode>sample string 17</PostalCode>
      <ReceiptByEmail>23</ReceiptByEmail>
      <SignedUp>2025-05-04T06:53:05.4775255+02:00</SignedUp>
      <SocialSecurityNr>sample string 25</SocialSecurityNr>
      <TermsConditionsApproved>true</TermsConditionsApproved>
      <BonusMoney>11</BonusMoney>
      <BonusPoints>10</BonusPoints>
      <CreationShop>sample string 3</CreationShop>
      <CustomerNumber>2</CustomerNumber>
      <DiscountMoney>9</DiscountMoney>
      <DiscountPoints>8</DiscountPoints>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <Modified>2025-05-04T06:53:05.4775255+02:00</Modified>
      <Password>sample string 5</Password>
      <RANK>7</RANK>
      <User>sample string 4</User>
    </MemberSearchResultViewModel>
    <MemberSearchResultViewModel>
      <Address>sample string 16</Address>
      <BirthDate>2025-05-04T06:53:05.4775255+02:00</BirthDate>
      <City>sample string 18</City>
      <ClubId>12</ClubId>
      <Country>sample string 19</Country>
      <Created>2025-05-04T06:53:05.4775255+02:00</Created>
      <DefaultShop>1</DefaultShop>
      <Email>sample string 21</Email>
      <EngineId>13</EngineId>
      <FirstName>sample string 14</FirstName>
      <Gender>sample string 20</Gender>
      <IsActive>true</IsActive>
      <LastName>sample string 15</LastName>
      <Notes>sample string 24</Notes>
      <Phone>sample string 22</Phone>
      <PostalCode>sample string 17</PostalCode>
      <ReceiptByEmail>23</ReceiptByEmail>
      <SignedUp>2025-05-04T06:53:05.4775255+02:00</SignedUp>
      <SocialSecurityNr>sample string 25</SocialSecurityNr>
      <TermsConditionsApproved>true</TermsConditionsApproved>
      <BonusMoney>11</BonusMoney>
      <BonusPoints>10</BonusPoints>
      <CreationShop>sample string 3</CreationShop>
      <CustomerNumber>2</CustomerNumber>
      <DiscountMoney>9</DiscountMoney>
      <DiscountPoints>8</DiscountPoints>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <Modified>2025-05-04T06:53:05.4775255+02:00</Modified>
      <Password>sample string 5</Password>
      <RANK>7</RANK>
      <User>sample string 4</User>
    </MemberSearchResultViewModel>
  </Results>
  <TotalNumberOfPages>3</TotalNumberOfPages>
  <TotalNumberOfRecords>4</TotalNumberOfRecords>
</PagedSearchResultMembersViewModel>