POST api/Search

Search members

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SearchFor		string	None.
FKID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SearchFor": "sample string 1",
  "FKID": 2
}

application/xml, text/xml

Sample:

<SearchParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPH.Entities.Search">
  <FKID>2</FKID>
  <SearchFor>sample string 1</SearchFor>
</SearchParameter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SearchParameter'.

Response Information

Resource Description

Collection of MemberList

Name	Type	Additional information
MemberID	integer	None.
SubscriberID	integer	None.
TitleID	integer	None.
TitleName	string	None.
FirstName	string	None.
LastName	string	None.
FullName	string	None.
IDNumber	string	None.
Phone	string	None.
Mobile	string	None.
Email	string	None.
InceptionDate	date	None.
MembershipNumber	string	None.
MedicalAidName	string	None.
MedicalAidOptionName	string	None.
Premium	decimal number	None.
GapCoverMembershipNumber	string	None.
GapCoverTypeName	string	None.
DOB	date	None.
BrokerGroupName	string	None.
BirthdaySent	boolean	None.
DateContributionReceived	date	None.
ContributionReceivedMonthSpan	integer	None.
RegisteredUserID	integer	None.
MembershipConfirmed	boolean	None.
MembershipConfirmedDiscrepancy	boolean	None.
DependantQty	integer	None.
BirthDayComment	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MemberID": 1,
    "SubscriberID": 2,
    "TitleID": 3,
    "TitleName": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "FullName": "sample string 5 sample string 6",
    "IDNumber": "sample string 7",
    "Phone": "sample string 8",
    "Mobile": "sample string 9",
    "Email": "sample string 10",
    "InceptionDate": "2026-03-10T20:18:27.2887581+02:00",
    "MembershipNumber": "sample string 11",
    "MedicalAidName": "sample string 12",
    "MedicalAidOptionName": "sample string 13",
    "Premium": 14.1,
    "GapCoverMembershipNumber": "sample string 15",
    "GapCoverTypeName": "sample string 16",
    "DOB": "2026-03-10T20:18:27.2887581+02:00",
    "BrokerGroupName": "sample string 17",
    "BirthdaySent": true,
    "DateContributionReceived": "2026-03-10T20:18:27.2887581+02:00",
    "ContributionReceivedMonthSpan": 19,
    "RegisteredUserID": 20,
    "MembershipConfirmed": false,
    "MembershipConfirmedDiscrepancy": false,
    "DependantQty": 21,
    "BirthDayComment": "sample string 22"
  },
  {
    "MemberID": 1,
    "SubscriberID": 2,
    "TitleID": 3,
    "TitleName": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "FullName": "sample string 5 sample string 6",
    "IDNumber": "sample string 7",
    "Phone": "sample string 8",
    "Mobile": "sample string 9",
    "Email": "sample string 10",
    "InceptionDate": "2026-03-10T20:18:27.2887581+02:00",
    "MembershipNumber": "sample string 11",
    "MedicalAidName": "sample string 12",
    "MedicalAidOptionName": "sample string 13",
    "Premium": 14.1,
    "GapCoverMembershipNumber": "sample string 15",
    "GapCoverTypeName": "sample string 16",
    "DOB": "2026-03-10T20:18:27.2887581+02:00",
    "BrokerGroupName": "sample string 17",
    "BirthdaySent": true,
    "DateContributionReceived": "2026-03-10T20:18:27.2887581+02:00",
    "ContributionReceivedMonthSpan": 19,
    "RegisteredUserID": 20,
    "MembershipConfirmed": false,
    "MembershipConfirmedDiscrepancy": false,
    "DependantQty": 21,
    "BirthDayComment": "sample string 22"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMemberList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPH.Entities.Search">
  <MemberList>
    <BirthDayComment>sample string 22</BirthDayComment>
    <BirthdaySent>true</BirthdaySent>
    <BrokerGroupName>sample string 17</BrokerGroupName>
    <ContributionReceivedMonthSpan>19</ContributionReceivedMonthSpan>
    <DOB>2026-03-10T20:18:27.2887581+02:00</DOB>
    <DateContributionReceived>2026-03-10T20:18:27.2887581+02:00</DateContributionReceived>
    <DependantQty>21</DependantQty>
    <Email>sample string 10</Email>
    <FirstName>sample string 5</FirstName>
    <GapCoverMembershipNumber>sample string 15</GapCoverMembershipNumber>
    <GapCoverTypeName>sample string 16</GapCoverTypeName>
    <IDNumber>sample string 7</IDNumber>
    <InceptionDate>2026-03-10T20:18:27.2887581+02:00</InceptionDate>
    <LastName>sample string 6</LastName>
    <MedicalAidName>sample string 12</MedicalAidName>
    <MedicalAidOptionName>sample string 13</MedicalAidOptionName>
    <MemberID>1</MemberID>
    <MembershipNumber>sample string 11</MembershipNumber>
    <Mobile>sample string 9</Mobile>
    <Phone>sample string 8</Phone>
    <Premium>14.1</Premium>
    <RegisteredUserID>20</RegisteredUserID>
    <SubscriberID>2</SubscriberID>
    <TitleID>3</TitleID>
    <TitleName>sample string 4</TitleName>
  </MemberList>
  <MemberList>
    <BirthDayComment>sample string 22</BirthDayComment>
    <BirthdaySent>true</BirthdaySent>
    <BrokerGroupName>sample string 17</BrokerGroupName>
    <ContributionReceivedMonthSpan>19</ContributionReceivedMonthSpan>
    <DOB>2026-03-10T20:18:27.2887581+02:00</DOB>
    <DateContributionReceived>2026-03-10T20:18:27.2887581+02:00</DateContributionReceived>
    <DependantQty>21</DependantQty>
    <Email>sample string 10</Email>
    <FirstName>sample string 5</FirstName>
    <GapCoverMembershipNumber>sample string 15</GapCoverMembershipNumber>
    <GapCoverTypeName>sample string 16</GapCoverTypeName>
    <IDNumber>sample string 7</IDNumber>
    <InceptionDate>2026-03-10T20:18:27.2887581+02:00</InceptionDate>
    <LastName>sample string 6</LastName>
    <MedicalAidName>sample string 12</MedicalAidName>
    <MedicalAidOptionName>sample string 13</MedicalAidOptionName>
    <MemberID>1</MemberID>
    <MembershipNumber>sample string 11</MembershipNumber>
    <Mobile>sample string 9</Mobile>
    <Phone>sample string 8</Phone>
    <Premium>14.1</Premium>
    <RegisteredUserID>20</RegisteredUserID>
    <SubscriberID>2</SubscriberID>
    <TitleID>3</TitleID>
    <TitleName>sample string 4</TitleName>
  </MemberList>
</ArrayOfMemberList>