ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

ServiceAreas

API	Description
GET api/ServiceAreas/GetDirectorates	No documentation available.

IVR

API	Description
POST api/IVR/Forms/Request	No documentation available.
GET api/IVR/OpeningTimes/Site	No documentation available.
GET api/IVR/OpeningTimes/Site/Code/{Code}	No documentation available.
GET api/IVR/Timetables/Site	No documentation available.
GET api/IVR/Timetables/TimeTable/Active/Site/{Name}/{ActivityName}/{IncludeOpenings}/{IncludeActivities}	No documentation available.
GET api/IVR/Bins/{UPRN}/{NumberOfDates}	No documentation available.
GET api/IVR/Address/GetAddressByUPRN?id={id}	No documentation available.
GET api/IVR/Address/Addresses?Postcode={Postcode}&HouseNameNumber={HouseNameNumber}&Street={Street}&Locality={Locality}&Town={Town}&County={County}	No documentation available.
GET api/IVR/Address/Streets/USRN?USRN={USRN}	No documentation available.

TestAndTrace

API	Description
GET api/TestAndTrace/GetTestSites?days={days}&checkWhetherClosingTimeHasPassed={checkWhetherClosingTimeHasPassed}	No documentation available.

SchoolPortal

API	Description
POST api/SchoolPortal/pupilonoffrolls	No documentation available.
GET api/SchoolPortal/pupilonoffrolls/{id}	No documentation available.
POST api/SchoolPortal/pupilonoffrolls/{id}/archive	No documentation available.
POST api/SchoolPortal/pupilonoffrolls/{id}/unarchive	No documentation available.
GET api/SchoolPortal/pupilonoffrolls?filter.Id={filter.Id}&filter.PupilName={filter.PupilName}&filter.UniquePupilNumber={filter.UniquePupilNumber}&filter.SchoolId={filter.SchoolId}&filter.SchoolAdminId={filter.SchoolAdminId}&filter.ShowActiveSubmissions={filter.ShowActiveSubmissions}&filter.ShowArchivedSubmissions={filter.ShowArchivedSubmissions}&filter.ClassificationId={filter.ClassificationId}&filter.FromDate={filter.FromDate}&filter.ToDate={filter.ToDate}&filter.SchoolAdminUsername={filter.SchoolAdminUsername}&offset={offset}&size={size}&sortOrder.SortField={sortOrder.SortField}&sortOrder.SortDirection={sortOrder.SortDirection}	No documentation available.
GET api/SchoolPortal/pupilonoffrolls/count?Id={Id}&PupilName={PupilName}&UniquePupilNumber={UniquePupilNumber}&SchoolId={SchoolId}&SchoolAdminId={SchoolAdminId}&ShowActiveSubmissions={ShowActiveSubmissions}&ShowArchivedSubmissions={ShowArchivedSubmissions}&ClassificationId={ClassificationId}&FromDate={FromDate}&ToDate={ToDate}&SchoolAdminUsername={SchoolAdminUsername}	No documentation available.
GET api/SchoolPortal/pupilonoffrolls/{id}/pdf	No documentation available.
GET api/SchoolPortal/schools?SchoolName={SchoolName}&offset={offset}&size={size}	No documentation available.
GET api/SchoolPortal/schools/count?SchoolName={SchoolName}	No documentation available.
GET api/SchoolPortal/schools	No documentation available.
GET api/SchoolPortal/schools/{id}	No documentation available.
POST api/SchoolPortal/schools	No documentation available.
POST api/SchoolPortal/schools/{schoolId}	No documentation available.
GET api/SchoolPortal/schools/{schoolId}/schooladmins	No documentation available.
POST api/SchoolPortal/schools/{schoolId}/schooladmins	No documentation available.
POST api/SchoolPortal/schools/schooladmins/{schoolAdminId}	No documentation available.
GET api/SchoolPortal/schooladmins/{username}	No documentation available.
GET api/SchoolPortal/schooladmins/{id}	No documentation available.
GET api/SchoolPortal/schooladmins/doesusernamealreadyexist/{username}	No documentation available.
POST api/SchoolPortal/schooladmins/{username}/RequestPasswordToken	No documentation available.
POST api/SchoolPortal/schooladmins/{id}/ResetPassword	No documentation available.
GET api/SchoolPortal/reasonsforleaving	No documentation available.
GET api/SchoolPortal/reasonsforleaving/{id}	No documentation available.
POST api/SchoolPortal/pupilonoffrollsclassifications/FromPupilOnOffRollDTO	No documentation available.
GET api/SchoolPortal/pupilonoffrollsclassifications	No documentation available.
GET api/SchoolPortal/schoolyears	No documentation available.
GET api/SchoolPortal/localauthorities	No documentation available.
GET api/SchoolPortal/schoolyears/{id}	No documentation available.
GET api/SchoolPortal/localauthorities/{id}	No documentation available.

Message

API	Description
POST api/Message/Email/Send	No documentation available.

BulkyBob

API	Description
GET api/BulkyBob/GetBobItem/id/{id}	No documentation available.
GET api/BulkyBob/GetSlotByGuid/guid/{guid}	No documentation available.
GET api/BulkyBob/GetRoundById/Id/{id}	No documentation available.
GET api/BulkyBob/GetRoundsForPostalArea/paId/{paId}	No documentation available.
GET api/BulkyBob/GetRoundsForPostcode/postcode/{postcode}	No documentation available.
GET api/BulkyBob/PostalArea/unselectedItem/{unselectedItem}	No documentation available.
GET api/BulkyBob/ListItemDescription	No documentation available.
GET api/BulkyBob/GetItemDescriptionById/Id/{id}	No documentation available.
GET api/BulkyBob/GetItemDescriptionById/slotid/{slotid}	No documentation available.
GET api/BulkyBob/GetItemsBySlot/slotid/{slotId}	No documentation available.
GET api/BulkyBob/ListNotesBySlot/slotid/{slotid}	No documentation available.
GET api/BulkyBob/ListSlotsByCollectionDate/date/{date}	No documentation available.
GET api/BulkyBob/ListCollectionItemCategories	No documentation available.
POST api/BulkyBob/CreateSlot	No documentation available.
POST api/BulkyBob/CreateItem	No documentation available.
POST api/BulkyBob/EditSlot	No documentation available.

SelectiveLicensing

API	Description
GET api/SelectiveLicensing/Part0Properties/{query}	No documentation available.

Contour

API	Description
GET api/Contour/GetMonthlySubmissionTotals/{formname}	No documentation available.
GET api/Contour/GetSubmissionTotalsByCaption/{formname}/{caption}	No documentation available.

Bin

API	Description
GET api/Bins/{UPRN}/{NumberOfDates}	No documentation available.
GET api/Bins/Postcode/{Postcode}	No documentation available.

Alexa

API	Description
GET api/Alexa/GetBestAddress/{FirstLine}/{Postcode}	No documentation available.
GET api/Alexa/GetNextBin/{UPRN}/{BinType}	No documentation available.
GET api/Alexa/GetNextBin/{FirstLine}/{Postcode}/{BinType}	No documentation available.
GET api/Alexa/GetMyNextBin/{BinType}	No documentation available.
GET api/Alexa/GetNextBins/{UPRN}	No documentation available.
GET api/Alexa/GetNextBins/{FirstLine}/{Postcode}	No documentation available.
GET api/Alexa/GetMyNextBins	No documentation available.
GET api/Alexa/GetMyPreviousAndNextBins	No documentation available.
POST api/Alexa/ReportMissingBinCollection	No documentation available.
GET api/Alexa/GetMyNearestSite/{SiteType}	No documentation available.
GET api/Alexa/GetNearestSite/{UPRN}/{SiteType}	No documentation available.
GET api/Alexa/GetNearestSite/{FirstLine}/{Postcode}/{SiteType}	No documentation available.
GET api/Alexa/GetMyNearestSiteOpeningTimes/{SiteType}	No documentation available.
GET api/Alexa/GetMyNearestSiteOpeningTimes/{SiteType}/{Day}	No documentation available.
GET api/Alexa/GetNearestSiteOpeningTimes/{UPRN}/{SiteType}	No documentation available.
GET api/Alexa/GetNearestSiteOpeningTimes/{FirstLine}/{Postcode}/{SiteType}	No documentation available.
GET api/Alexa/GetNearestSiteOpeningTimes/{UPRN}/{SiteType}/{Day}	No documentation available.
GET api/Alexa/GetNearestSiteOpeningTimes/{FirstLine}/{Postcode}/{SiteType}/{Day}	No documentation available.
GET api/Alexa/GetNearestTestCentre/{FirstLine}/{Postcode}	No documentation available.
GET api/Alexa/GetNearestTestCentre/{UPRN}	No documentation available.
GET api/Alexa/GetMyNearestTestCentre	No documentation available.
GET api/Alexa/GetSite/{SiteCode}	No documentation available.
GET api/Alexa/GetSiteOpeningTimes/{SiteCode}	No documentation available.
GET api/Alexa/GetSiteOpeningTimes/{SiteCode}/{Day}	No documentation available.

Payment

API	Description
GET api/Payment/QueryAuthRequests/{CallingApplicationIdentifier}/{Column}/{Operator}/{Value}	No documentation available.

Marf

API	Description
POST api/Marf/AddReferral	No documentation available.
GET api/Marf/GetReferrals?Id={Id}&ReferrerFirstName={ReferrerFirstName}&ReferrerSurname={ReferrerSurname}&ChildFirstName={ChildFirstName}&ChildSurname={ChildSurname}&FromDate={FromDate}&ToDate={ToDate}&Reason={Reason}&HaveConsideredGCP2={HaveConsideredGCP2}&offset={offset}&size={size}	No documentation available.
GET api/Marf/GetReferral/{id}	No documentation available.
GET api/Marf/GetReferralsCount?Id={Id}&ReferrerFirstName={ReferrerFirstName}&ReferrerSurname={ReferrerSurname}&ChildFirstName={ChildFirstName}&ChildSurname={ChildSurname}&FromDate={FromDate}&ToDate={ToDate}&Reason={Reason}&HaveConsideredGCP2={HaveConsideredGCP2}	No documentation available.
GET api/Marf/MethodsOfContact	No documentation available.
GET api/Marf/MethodsOfContact/{id}	No documentation available.
GET api/Marf/ThresholdLevels	No documentation available.
GET api/Marf/ThresholdLevels/{id}	No documentation available.
GET api/Marf/Genders	No documentation available.
GET api/Marf/Ethnicities	No documentation available.
GET api/Marf/RelationshipsToChild	No documentation available.
GET api/Marf/Nationalities	No documentation available.
GET api/Marf/Religions	No documentation available.
GET api/Marf/ReferralReasons	No documentation available.
GET api/Marf/ReferralTypes	No documentation available.
GET api/Marf/ReferralTypes/{id}	No documentation available.
GET api/Marf/SourceTypeSubOptions/{label}/{parentId}	No documentation available.
GET api/Marf/SourceTypeSubOption/{id}	No documentation available.
GET api/Marf/CSEIndicators	No documentation available.
GET api/Marf/Languages	No documentation available.
GET api/Marf/NatureOfDisabilityList	No documentation available.
GET api/Marf/RefugeeStatuses	No documentation available.
GET api/Marf/Agencies	No documentation available.
GET api/Marf/CSELookedAfterHistories	No documentation available.
GET api/Marf/AgenciesNoConsent	No documentation available.
GET api/Marf/LeadAgencyInvolvements	No documentation available.
GET api/Marf/ChildAddressTypes	No documentation available.
GET api/Marf/GetEHATForm/{id}	No documentation available.
GET api/Marf/GetTool/{id}	No documentation available.
GET api/Marf/GetMonthlyTotals	No documentation available.
GET api/Marf/GetReferralReasonsTotals?FromDate={FromDate}&ToDate={ToDate}	No documentation available.
GET api/Marf/GetEthnicitiesTotals?FromDate={FromDate}&ToDate={ToDate}	No documentation available.
GET api/Marf/GetReferralTypesTotals	No documentation available.
GET api/Marf/GetChildrenAgesTotals	No documentation available.
GET api/Marf/GetReferralSubmissionsAsync	No documentation available.
GET api/Marf/GetReferralsYearMonthNumberEmailsAsync	No documentation available.

TaxiBooking

API	Description
GET api/TaxiBooking/TaxiBookingGetServiceList	No documentation available.
GET api/TaxiBooking/GetNextAvailableBookingDates	No documentation available.
GET api/TaxiBooking/GetAvailableBookingSlots/{bookingDay}	No documentation available.
GET api/TaxiBooking/GetAvailableBookingSlotsBySlotId/{id}	No documentation available.
POST api/TaxiBooking/TaxiBooking	No documentation available.
GET api/TaxiBooking/GetTaxiBookingById/{id}	No documentation available.
GET api/TaxiBooking/GetTaxiBookingByGuid/{guid}	No documentation available.
POST api/TaxiBooking/CancelExistingBooking/{id}	No documentation available.

Notify

API	Description
POST api/Notify/DeliveryReceipt	No documentation available.
POST api/Notify/ReceivedTextMessage	No documentation available.
POST api/Notify/CreateSmsBatch	No documentation available.
GET api/Notify/RemoveSmsBatch/ClientReference/{ClientReference}	No documentation available.
POST api/Notify/CreateSMSSubscription	No documentation available.
POST api/Notify/CreateSMSNumberSubscription	No documentation available.
GET api/Notify/RemoveSMSNumberSubscription/{MobileNumber}	No documentation available.

Site

API	Description
GET api/site/badrequest	No documentation available.

Forms

API	Description
POST api/Forms/Request	No documentation available.

Address

API	Description
GET api/Address/GetAddressByUPRN?id={id}	No documentation available.
GET api/Address/Addresses?Postcode={Postcode}&HouseNameNumber={HouseNameNumber}&Street={Street}&Locality={Locality}&Town={Town}&County={County}	No documentation available.
GET api/Address/Streets/USRN?USRN={USRN}	No documentation available.

Timetables

API	Description
GET api/Timetables/Site	No documentation available.
GET api/Timetables/TimeTable/Active/Site/{Name}/{IncludeOpenings}/{IncludeActivities}	No documentation available.

CouncilTax

API	Description
GET api/CouncilTax/GetCouncilTaxBand/{UPRN}	No documentation available.

TOR

API	Description
POST api/TOR/AddApplication	No documentation available.
GET api/TOR/Applications?ApplicantName={ApplicantName}&TenancyType={TenancyType}&EmploymentStatus={EmploymentStatus}&ReceivingPension={ReceivingPension}&PayIntoPension={PayIntoPension}&StartDate={StartDate}&EndDate={EndDate}&AgeLowerLimit={AgeLowerLimit}&AgeUpperLimit={AgeUpperLimit}&offset={offset}&size={size}	No documentation available.
GET api/TOR/TORHousingAssociations	No documentation available.
GET api/TOR/Applications/count?ApplicantName={ApplicantName}&TenancyType={TenancyType}&EmploymentStatus={EmploymentStatus}&ReceivingPension={ReceivingPension}&PayIntoPension={PayIntoPension}&StartDate={StartDate}&EndDate={EndDate}&AgeLowerLimit={AgeLowerLimit}&AgeUpperLimit={AgeUpperLimit}	No documentation available.
GET api/TOR/Applications/{id}	No documentation available.

Ofsted

API	Description
GET api/Ofsted/LocalAuthorityChildcareRegister	No documentation available.

OpeningTimes

API	Description
GET api/OpeningTimes/Site	No documentation available.
GET api/OpeningTimes/Site/Code/{Code}	No documentation available.

TextService

API	Description
POST api/TextService/CreateText	No documentation available.
POST api/TextService/CancelText	No documentation available.
POST api/TextService/UpdateText	No documentation available.
GET api/TextService/GetMessageByAppRef/{appref}/{appname}	No documentation available.
GET api/TextService/GetMessageById/{id}	No documentation available.

Polling

API	Description
GET api/PollingStation/UPRN/{UPRN}	No documentation available.

TravelPasses

API	Description
POST api/TravelPasses	No documentation available.
GET api/TravelPasses/{applicationId}	No documentation available.
POST api/TravelPasses/Duplicate	No documentation available.
GET api/TravelPasses/Duplicate/{duplicateId}	No documentation available.
POST api/TravelPasses/Renewal	No documentation available.
GET api/TravelPasses/Renewal/{renewalId}	No documentation available.
POST api/TravelPasses/Appeal	No documentation available.
GET api/TravelPasses/Appeal/{appealId}	No documentation available.
GET api/TravelPasses/Genders	No documentation available.
GET api/TravelPasses/RelationshipsToChild	No documentation available.
GET api/TravelPasses/TravelMethods	No documentation available.
GET api/TravelPasses/DuplicateReasons	No documentation available.
GET api/TravelPasses/TypesOfPasses	No documentation available.
GET api/TravelPasses/RenewalTypes	No documentation available.