POST api/Questionnaire/FindNeedAnalysisByDate

Find need analysis by date range

Request Information

URI Parameters

None.

Body Parameters

DateParm
NameDescriptionTypeAdditional information
StartDate

date

None.

EndDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "StartDate": "2026-03-10T20:26:02.1453181+02:00",
  "EndDate": "2026-03-10T20:26:02.1453181+02:00"
}

application/xml, text/xml

Sample:
<DateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPH.Entities.Parameters">
  <EndDate>2026-03-10T20:26:02.1453181+02:00</EndDate>
  <StartDate>2026-03-10T20:26:02.1453181+02:00</StartDate>
</DateParm>

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 'DateParm'.

Response Information

Resource Description

Collection of NeedAnalysis
NameDescriptionTypeAdditional information
NeedAnalysisID

integer

None.

SubscriberID

integer

None.

RegisteredUserID

integer

None.

MemberID

integer

None.

EmployerName

string

None.

TitleID

integer

None.

FirstName

string

None.

LastName

string

None.

IDNumber

string

None.

Phone

string

None.

Mobile

string

None.

Email

string

None.

PhysicalAddress

string

None.

ProvinceID

integer

None.

GrossIncome

decimal number

None.

MedicalAidBudget

decimal number

None.

RegisteredOnRSAMedicalAid

boolean

None.

TwentyFourMonthCover

boolean

None.

NinetyDayMembershipBreak

boolean

None.

MembershipFeedback

string

None.

MedicalAidPlanTypeID

integer

None.

ReimbursementRateID

integer

None.

DiagnosedWithCancer

boolean

None.

PlannedHospitalisationComment

string

None.

UtilisePrivateHospitalNetwork

boolean

None.

HasChronicConditions

boolean

None.

MedicationSupplierID

integer

None.

ChronicConditionID

string

None.

ChronicConditions

string

None.

TotalSpentGP

decimal number

None.

TotalSpentSpecialist

decimal number

None.

TotalSpentAcute

decimal number

None.

TotalSpentOptometry

decimal number

None.

TotalSpentDentist

decimal number

None.

TotalSpentOther

decimal number

None.

TotalSpentOtherComment

string

None.

ReferredBy

string

None.

DateFlag

date

None.

FullName

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "NeedAnalysisID": 1,
    "SubscriberID": 2,
    "RegisteredUserID": 3,
    "MemberID": 4,
    "EmployerName": "sample string 5",
    "TitleID": 6,
    "FirstName": "sample string 7",
    "LastName": "sample string 8",
    "IDNumber": "sample string 9",
    "Phone": "sample string 10",
    "Mobile": "sample string 11",
    "Email": "sample string 12",
    "PhysicalAddress": "sample string 13",
    "ProvinceID": 14,
    "GrossIncome": 15.1,
    "MedicalAidBudget": 16.1,
    "RegisteredOnRSAMedicalAid": true,
    "TwentyFourMonthCover": true,
    "NinetyDayMembershipBreak": true,
    "MembershipFeedback": "sample string 20",
    "MedicalAidPlanTypeID": 21,
    "ReimbursementRateID": 22,
    "DiagnosedWithCancer": true,
    "PlannedHospitalisationComment": "sample string 24",
    "UtilisePrivateHospitalNetwork": true,
    "HasChronicConditions": true,
    "MedicationSupplierID": 27,
    "ChronicConditionID": "sample string 28",
    "ChronicConditions": "sample string 29",
    "TotalSpentGP": 30.1,
    "TotalSpentSpecialist": 31.1,
    "TotalSpentAcute": 32.1,
    "TotalSpentOptometry": 33.1,
    "TotalSpentDentist": 34.1,
    "TotalSpentOther": 35.1,
    "TotalSpentOtherComment": "sample string 36",
    "ReferredBy": "sample string 37",
    "DateFlag": "2026-03-10T20:26:02.1453181+02:00",
    "FullName": "sample string 7 sample string 8"
  },
  {
    "NeedAnalysisID": 1,
    "SubscriberID": 2,
    "RegisteredUserID": 3,
    "MemberID": 4,
    "EmployerName": "sample string 5",
    "TitleID": 6,
    "FirstName": "sample string 7",
    "LastName": "sample string 8",
    "IDNumber": "sample string 9",
    "Phone": "sample string 10",
    "Mobile": "sample string 11",
    "Email": "sample string 12",
    "PhysicalAddress": "sample string 13",
    "ProvinceID": 14,
    "GrossIncome": 15.1,
    "MedicalAidBudget": 16.1,
    "RegisteredOnRSAMedicalAid": true,
    "TwentyFourMonthCover": true,
    "NinetyDayMembershipBreak": true,
    "MembershipFeedback": "sample string 20",
    "MedicalAidPlanTypeID": 21,
    "ReimbursementRateID": 22,
    "DiagnosedWithCancer": true,
    "PlannedHospitalisationComment": "sample string 24",
    "UtilisePrivateHospitalNetwork": true,
    "HasChronicConditions": true,
    "MedicationSupplierID": 27,
    "ChronicConditionID": "sample string 28",
    "ChronicConditions": "sample string 29",
    "TotalSpentGP": 30.1,
    "TotalSpentSpecialist": 31.1,
    "TotalSpentAcute": 32.1,
    "TotalSpentOptometry": 33.1,
    "TotalSpentDentist": 34.1,
    "TotalSpentOther": 35.1,
    "TotalSpentOtherComment": "sample string 36",
    "ReferredBy": "sample string 37",
    "DateFlag": "2026-03-10T20:26:02.1453181+02:00",
    "FullName": "sample string 7 sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNeedAnalysis xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPH.Entities.Questionnaire">
  <NeedAnalysis>
    <ChronicConditionID>sample string 28</ChronicConditionID>
    <ChronicConditions>sample string 29</ChronicConditions>
    <DateFlag>2026-03-10T20:26:02.1453181+02:00</DateFlag>
    <DiagnosedWithCancer>true</DiagnosedWithCancer>
    <Email>sample string 12</Email>
    <EmployerName>sample string 5</EmployerName>
    <FirstName>sample string 7</FirstName>
    <GrossIncome>15.1</GrossIncome>
    <HasChronicConditions>true</HasChronicConditions>
    <IDNumber>sample string 9</IDNumber>
    <LastName>sample string 8</LastName>
    <MedicalAidBudget>16.1</MedicalAidBudget>
    <MedicalAidPlanTypeID>21</MedicalAidPlanTypeID>
    <MedicationSupplierID>27</MedicationSupplierID>
    <MemberID>4</MemberID>
    <MembershipFeedback>sample string 20</MembershipFeedback>
    <Mobile>sample string 11</Mobile>
    <NeedAnalysisID>1</NeedAnalysisID>
    <NinetyDayMembershipBreak>true</NinetyDayMembershipBreak>
    <Phone>sample string 10</Phone>
    <PhysicalAddress>sample string 13</PhysicalAddress>
    <PlannedHospitalisationComment>sample string 24</PlannedHospitalisationComment>
    <ProvinceID>14</ProvinceID>
    <ReferredBy>sample string 37</ReferredBy>
    <RegisteredOnRSAMedicalAid>true</RegisteredOnRSAMedicalAid>
    <RegisteredUserID>3</RegisteredUserID>
    <ReimbursementRateID>22</ReimbursementRateID>
    <SubscriberID>2</SubscriberID>
    <TitleID>6</TitleID>
    <TotalSpentAcute>32.1</TotalSpentAcute>
    <TotalSpentDentist>34.1</TotalSpentDentist>
    <TotalSpentGP>30.1</TotalSpentGP>
    <TotalSpentOptometry>33.1</TotalSpentOptometry>
    <TotalSpentOther>35.1</TotalSpentOther>
    <TotalSpentOtherComment>sample string 36</TotalSpentOtherComment>
    <TotalSpentSpecialist>31.1</TotalSpentSpecialist>
    <TwentyFourMonthCover>true</TwentyFourMonthCover>
    <UtilisePrivateHospitalNetwork>true</UtilisePrivateHospitalNetwork>
  </NeedAnalysis>
  <NeedAnalysis>
    <ChronicConditionID>sample string 28</ChronicConditionID>
    <ChronicConditions>sample string 29</ChronicConditions>
    <DateFlag>2026-03-10T20:26:02.1453181+02:00</DateFlag>
    <DiagnosedWithCancer>true</DiagnosedWithCancer>
    <Email>sample string 12</Email>
    <EmployerName>sample string 5</EmployerName>
    <FirstName>sample string 7</FirstName>
    <GrossIncome>15.1</GrossIncome>
    <HasChronicConditions>true</HasChronicConditions>
    <IDNumber>sample string 9</IDNumber>
    <LastName>sample string 8</LastName>
    <MedicalAidBudget>16.1</MedicalAidBudget>
    <MedicalAidPlanTypeID>21</MedicalAidPlanTypeID>
    <MedicationSupplierID>27</MedicationSupplierID>
    <MemberID>4</MemberID>
    <MembershipFeedback>sample string 20</MembershipFeedback>
    <Mobile>sample string 11</Mobile>
    <NeedAnalysisID>1</NeedAnalysisID>
    <NinetyDayMembershipBreak>true</NinetyDayMembershipBreak>
    <Phone>sample string 10</Phone>
    <PhysicalAddress>sample string 13</PhysicalAddress>
    <PlannedHospitalisationComment>sample string 24</PlannedHospitalisationComment>
    <ProvinceID>14</ProvinceID>
    <ReferredBy>sample string 37</ReferredBy>
    <RegisteredOnRSAMedicalAid>true</RegisteredOnRSAMedicalAid>
    <RegisteredUserID>3</RegisteredUserID>
    <ReimbursementRateID>22</ReimbursementRateID>
    <SubscriberID>2</SubscriberID>
    <TitleID>6</TitleID>
    <TotalSpentAcute>32.1</TotalSpentAcute>
    <TotalSpentDentist>34.1</TotalSpentDentist>
    <TotalSpentGP>30.1</TotalSpentGP>
    <TotalSpentOptometry>33.1</TotalSpentOptometry>
    <TotalSpentOther>35.1</TotalSpentOther>
    <TotalSpentOtherComment>sample string 36</TotalSpentOtherComment>
    <TotalSpentSpecialist>31.1</TotalSpentSpecialist>
    <TwentyFourMonthCover>true</TwentyFourMonthCover>
    <UtilisePrivateHospitalNetwork>true</UtilisePrivateHospitalNetwork>
  </NeedAnalysis>
</ArrayOfNeedAnalysis>