ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Callback

API	Description
POST Api/Retailer/Callback/{retID}	No documentation available.
POST Api/v1/HealthLead/Callback	No documentation available.

User

API	Description
POST Api/User/Register	No documentation available.
POST Api/User/ForgotPassword	No documentation available.
POST Api/User/ResetPassword	No documentation available.
POST Api/User/CheckTokenResetPassword	No documentation available.
POST Api/User/ChangePassword	No documentation available.
POST Api/Login	No documentation available.
POST Api/Logout	No documentation available.
GET Api/User/GetRoles	No documentation available.
POST Api/User/AddUser	No documentation available.
POST Api/User/UpdateUser	No documentation available.
GET Api/User/GetUserDetail/{UserID}	No documentation available.
POST Api/User/DeleteUser?UserID={UserID}	No documentation available.
POST Api/User/Change2FAEmail	No documentation available.
POST Api/User/ReSend2FaEmail	No documentation available.
POST Api/User/Verify2FACode?Email2FACode={Email2FACode}	No documentation available.
POST Api/User/DisableEnable2FAEmail?value={value}	No documentation available.
GET Api/User/GetCurrentStatus2FAEmail	No documentation available.
POST Api/Dashboard/Login	No documentation available.

Master

API	Description
POST Api/master/other/ClearCache?cacheKey={cacheKey}	No documentation available.
GET Api/CRN/Detail?CRN={CRN}&email={email}	No documentation available.
GET Api/Lead/Detail?leadID={leadID}&email={email}	No documentation available.
GET Api/Lead/DetailByPhone?phoneNumber={phoneNumber}&leadId={leadId}&crn={crn}	No documentation available.
POST Api/TariffType/Fields	No documentation available.
GET Api/StreetType/List	No documentation available.
GET Api/CurrentRetailer/List	No documentation available.
GET Api/ContractedRetailer/List	No documentation available.
GET Api/CurrentInternetRetailer/List	No documentation available.
GET Api/Distributor/List/{EnergyType}	No documentation available.
GET Api/Suburb/List/{postcode}	No documentation available.
GET Api/Title/List	No documentation available.
GET Api/SendLead?Source={Source}&FirstName={FirstName}&LastName={LastName}&BusinessName={BusinessName}&ABN={ABN}&PostCode={PostCode}&PhoneNumber={PhoneNumber}&PhoneNumber2={PhoneNumber2}&ContactTime={ContactTime}&Email={Email}&Comments={Comments}&ReferrID={ReferrID}&GSFID={GSFID}&Suburb={Suburb}&MoveIn={MoveIn}&ServiceType={ServiceType}&CustomerType={CustomerType}&SolarPanel={SolarPanel}&ElectricityUsage={ElectricityUsage}&GasUsage={GasUsage}&BillUpload={BillUpload}&Utm_source={Utm_source}&SolarInterested={SolarInterested}&InternetPlanType={InternetPlanType}&Speed={Speed}&SpeedProfile={SpeedProfile}&MoveInDate={MoveInDate}&EnergyConnected={EnergyConnected}&Bundle={Bundle}&CurrentInternetProvider={CurrentInternetProvider}	No documentation available.
POST Api/CreateSolarLead	No documentation available.
POST Api/CreateLPGLead	No documentation available.
GET Api/State	No documentation available.
GET Api/PublicHoliday	No documentation available.
POST Api/SendGoogleLeadForm	No documentation available.
GET Api/DBUploadVersion	No documentation available.
GET Api/GetDBFile/{ID}	No documentation available.
POST Api/ReferralFactoryLead	No documentation available.
GET Api/UpdateAllToKlaviyo/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}	No documentation available.
GET Api/UpdateAllFailedToKlaviyo/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}	No documentation available.
GET Api/UpdateAllToGenesys/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}	No documentation available.
GET Api/UpdateAllFailedToGenesys/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}	No documentation available.
GET Api/GetAllCallRecordFromGenesys/{type}	No documentation available.
GET Api/Master/Job/UpdateAllToSolarChoice/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}	No documentation available.
GET Api/Master/Job/UpdateAllFailedToSolarChoice/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}	No documentation available.
GET Api/Master/Job/UpdateAllToFacebook/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}&testEventCode={testEventCode}	No documentation available.
GET Api/Master/Job/UpdateAllFailedToFacebook/{type}?dateStart={dateStart}&limit={limit}&minRetry={minRetry}&maxRetry={maxRetry}&testEventCode={testEventCode}	No documentation available.

CallCenter

API	Description
GET Api/CallCenter/List	No documentation available.

CampaignCode

API	Description
GET Api/CampaignCode/List?Category={Category}&CallCenterID={CallCenterID}&isALL={isALL}	No documentation available.

Presale

API	Description
POST Api/Presale/CampaignSelection	No documentation available.
POST Api/Presale/CustomerInformation	No documentation available.
POST Api/Presale/CustomerInformation/v2	No documentation available.
POST Api/Presale/InternetCustomerInformation	No documentation available.
POST Api/Presale/CustomerDetails	No documentation available.
POST Api/Presale/CustomerDetails/v2	No documentation available.
POST Api/Presale/InternetCustomerDetails	No documentation available.
GET Api/Presale/Detail/{PresaleID}	No documentation available.
GET Api/Presale/DetailInternet/{PresaleID}	No documentation available.
GET Api/Presale/GetNotesList/{presaleID}	No documentation available.
POST Api/Presale/UpdateNote	No documentation available.
POST Api/Presale/InsertRawData?isLocal={isLocal}	No documentation available.

Tariff

API	Description
POST Api/TariffCode/List	No documentation available.
POST Api/NMI/DistributorTariff/List	No documentation available.
POST Api/Solar/SolarTariff/List	No documentation available.

Comparison

API	Description
GET Api/Comparison/Plans/{PresaleID}/{EnergyType}/{SolarCreditDeducted}	No documentation available.
GET Api/Comparison/LowestAnnualPlans/{stateCode}	No documentation available.
GET Api/Comparison/LowestAnnualPlansV2?stateCode={stateCode}&distributorName={distributorName}&tariffName={tariffName}	No documentation available.
GET Api/Comparison/LowestAnnualWPWidgetFilters?stateId={stateId}&distributorId={distributorId}&tariffName={tariffName}	No documentation available.
POST Api/Comparison/SaveComparisonHistory/{PresaleID}/{EnergyType}	No documentation available.
GET Api/Comparison/InternetPlans/{PresaleID}/{EnergyType}/{SolarCreditDeducted}	No documentation available.
POST Api/Comparison/PlanSelection	No documentation available.
POST Api/Comparison/Check	No documentation available.
POST Api/Comparison/Quote	No documentation available.
POST Api/Comparison/PlanRankings	No documentation available.

Sales

API	Description
POST Api/Sales/SignUp?isLocal={isLocal}	No documentation available.
POST Api/InternetSales/SignUp?isLocal={isLocal}	No documentation available.
POST Api/Sales/Fields/List	No documentation available.
GET Api/Sales/GetEnergySignupHistoryByCRN/{crn}	No documentation available.
GET Api/Sales/GetInternetSignupHistoryByCRN/{crn}	No documentation available.
GET Api/Sales/SendGoogleReviewInvitation?salesId={salesId}	No documentation available.
GET Api/GetSubmissionHistoryByCRN/{crn}	No documentation available.

Report

API	Description
GET Api/Report/Sales/List/{retID}/{dateStart}/{dateEnd}/{isSendToAdmin}	No documentation available.
GET Api/Report/Sales/CAFManual?retID={retID}&salesId={salesId}	No documentation available.
GET Api/Report/Sales/SendApi/{retID}/{dateStart}/{dateEnd}	No documentation available.
GET Api/Report/Sales/ResendApiWhenNoCallbackReceived?retID={retID}&dateStart={dateStart}&dateEnd={dateEnd}&whenNoCallbackInMinutes={whenNoCallbackInMinutes}	No documentation available.
GET Api/Report/Sales/SendMailWhenNoCallbackReceived?retID={retID}&dateStart={dateStart}&dateEnd={dateEnd}&whenNoCallbackInMinutes={whenNoCallbackInMinutes}&isIncludeTestData={isIncludeTestData}	No documentation available.
GET Api/Report/Sales/GetSaleStatusAPI/{retID}/{dateStart}/{dateEnd}	No documentation available.
GET Api/Report/Sales/SendUrgentSales/{retID}	No documentation available.
GET Api/Report/Sales/SendSalesReport/{retID}/{dateStart}/{dateEnd}	No documentation available.
GET Api/Report/SolarLead/SendToProvider/{dateStart}/{dateEnd}	No documentation available.
GET Api/Report/SolarLead/SendToProviderById/{solarLeadId}	No documentation available.
GET Api/Report/LPGLead/SendCAF/{dateStart}/{dateEnd}/{isSendToAdmin}	No documentation available.
GET Api/Report/SendDailyPerformanceReport?dateStart={dateStart}&dateEnd={dateEnd}&categories={categories}	No documentation available.
GET Api/Report/BingAuth?code={code}	No documentation available.
GET Api/Report/SendNotificationSalesNotYetSentViaApi?minutes={minutes}&addDays={addDays}&isIncludeTestData={isIncludeTestData}	No documentation available.
GET Api/Report/SendDailyKlaviyoReport?dateStart={dateStart}&dateEnd={dateEnd}	No documentation available.
GET Api/Report/UpdateCompareClubLeadStatus/{salesId}	No documentation available.

Validation

API	Description
POST Api/Validate/Residential/Sale	No documentation available.
POST Api/Validate/Residential/Sale/Origin	No documentation available.
POST Api/Validate/MIRN	No documentation available.

ChurnRequest

API	Description
GET Api/ChurnReport/Sales/List/{retID}/{dateStart}/{dateEnd}	No documentation available.

General

API	Description
GET Api/General/GetAgentSalesPerformance?Type={Type}&CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&Date={Date}	No documentation available.
GET Api/General/GetMonthlyRetailerSaleTracker?CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&Year={Year}&Month={Month}	No documentation available.
GET Api/General/GetMonthlyAgentQAStats?CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&Year={Year}&Month={Month}	No documentation available.
GET Api/General/GetMonthlyAgentQAStats/{UserId}?CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&Year={Year}&Month={Month}	No documentation available.
POST Api/General/InsertUpdateAgentQAStats	No documentation available.
GET Api/General/GetUserListAgentQAStats	No documentation available.
GET Api/General/GetAgentGenesysPerformance?CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&DateStart={DateStart}&DateEnd={DateEnd}&IntervalType={IntervalType}&CampaignType={CampaignType}	No documentation available.
GET Api/General/GetAgentReportHealth?Type={Type}&CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&Date={Date}	No documentation available.
GET Api/General/GetAgentGenesysPerformanceExport?SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&DateStart={DateStart}&DateEnd={DateEnd}&IntervalType={IntervalType}&CampaignType={CampaignType}	No documentation available.
GET Api/General/SyncGenesysUsers	No documentation available.
GET Api/General/GetMonthlyAgentQAStatsInternet?CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&Year={Year}&Month={Month}	No documentation available.
GET Api/General/GetMonthlyAgentQAStatsInternet/{UserId}?CurrentPageNumber={CurrentPageNumber}&PageSize={PageSize}&SearchExpression={SearchExpression}&SortColumn={SortColumn}&SortExpression={SortExpression}&Year={Year}&Month={Month}	No documentation available.
POST Api/General/InsertUpdateAgentQAStatsInternet	No documentation available.
GET Api/General/GetUserListAgentQAStatsInternet	No documentation available.
GET Api/General/GetGenesysStatusLead?Date={Date}	No documentation available.
GET Api/General/Job/SetGenesysStatusLead?StartDate={StartDate}&EndDate={EndDate}	No documentation available.
GET Api/General/Job/UpdateGenesysCallResult?isDeleteOldData={isDeleteOldData}&isSaveGenesysCSVToDb={isSaveGenesysCSVToDb}&deleteOldDataAfterDays={deleteOldDataAfterDays}&contactListIds={contactListIds}&additionalContactListIds={additionalContactListIds}	No documentation available.
GET Api/General/CleanupGenesysOldData?deleteOldDataAfterDays={deleteOldDataAfterDays}&contactListIds={contactListIds}	No documentation available.

Marketing

API	Description
POST Api/Marketing/SendReferralMarketingCampaignEmail	No documentation available.

Health

API	Description
GET Api/v1/HealthCoverType	No documentation available.
GET Api/v1/HealthProvider	No documentation available.
POST Api/v1/HealthLead	No documentation available.
GET Api/v1/HealthLifeStageTypes	No documentation available.
GET Api/v1/HealthLeadCallRequest/GetById/{healthLeadCallRequestId}	No documentation available.
GET Api/v1/HealthLead/Job/Outcomes?dateStart={dateStart}&dateEnd={dateEnd}&dateStartAddMinute={dateStartAddMinute}	No documentation available.
GET Api/v1/HealthLead/SendToPartnerById?partnerName={partnerName}&healthLeadId={healthLeadId}	No documentation available.

SubmissionHistory

API	Description
GET Api/SubmissionHistory/Job/UploadFileToCloud?afterDays={afterDays}	No documentation available.
GET Api/SubmissionHistory/GetFileValue?relativePath={relativePath}	No documentation available.

DataMaintenance

API	Description
GET Api/DataMaintenance/Job/SubmissionHistory?afterDays={afterDays}	No documentation available.
GET Api/DataMaintenance/Job/SubmissionHistory/CleanUnusedLocalFile?afterDays={afterDays}	No documentation available.

BpidVefs

API	Description
GET Api/BpidVefs?postcode={postcode}&suburb={suburb}&customerTypeId={customerTypeId}&energyTypeId={energyTypeId}&retailerId={retailerId}&tariffType={tariffType}&planName={planName}	No documentation available.
GET Api/BpidVefs/Plans?postcode={postcode}&suburb={suburb}&customerTypeId={customerTypeId}&energyTypeId={energyTypeId}&retailerId={retailerId}&tariffType={tariffType}	No documentation available.
GET Api/BpidVefs/TariffTypes?postcode={postcode}&suburb={suburb}&customerTypeId={customerTypeId}&energyTypeId={energyTypeId}&retailerId={retailerId}	No documentation available.
POST Api/BpidVefs/SendEmail?presaleId={presaleId}&description={description}&link={link}	No documentation available.

Website

API	Description
GET Api/websites/TariffUsageMappings	No documentation available.
GET Api/websites/plans?tariffType={tariffType}&distributorId={distributorId}&retailerId={retailerId}	No documentation available.
GET Api/websites/rates?retailerId={retailerId}&distributorId={distributorId}&tariffType={tariffType}&planName={planName}&solarTariff={solarTariff}	No documentation available.
GET api/websites/calculation?PlanId={PlanId}&TariffType={TariffType}&DistributorId={DistributorId}&SolarTariff={SolarTariff}&HasUsageChargeDiscount={HasUsageChargeDiscount}&HasSupplyChargeDiscount={HasSupplyChargeDiscount}&HasSolar={HasSolar}&BillDays={BillDays}&PeakUsage={PeakUsage}&OffPeakUsage={OffPeakUsage}&Cl1Usage={Cl1Usage}&Cl2Usage={Cl2Usage}&ShoulderUsage={ShoulderUsage}&SolarUsage={SolarUsage}	No documentation available.
GET api/websites/solartariff?StateCode={StateCode}	No documentation available.