Consents
| API | Description |
|---|---|
| GET api/Consents/CCC/IsReady/{consentId} |
Provides Building Consent ready for CCC status |
| GET api/Consents/BConCategories |
Provides list of BCon Categories (restricted datacom). |
| GET api/Consents/isApplication/{consentId} |
is Application ID (ram_id) existing |
| GET api/Consents/DBHCategories |
Provides list of DBH Categories (restricted datacom). |
| GET api/Consents/StatsTypes |
Provides list of Statistics NZ Building Types (restricted datacom). |
| GET api/Consents/PrimaryUses |
Provides list of Primary uses for the vetting form (restricted datacom). |
| POST api/Consents/DownloadFiles/{title}?intYear={intYear} |
Note, Under Construction!!! todo Process only the file download and upload into Hubble Requires the Posted xml |
| POST api/Consents/DownloadFiles/{intYear}/{title} |
Note, Under Construction!!! todo Process only the file download and upload into Hubble Requires the Posted xml |
| POST api/Consents/sendXML |
Provides XML from Sphere Consent process for regulatory system update, (restricted datacom). |
| POST api/LIM/sendXML |
Provides XML from Sphere Consent process for regulatory system update, (restricted datacom). |
| POST api/FoodAct/sendXML |
Provides XML from Sphere Consent process for regulatory system update, (restricted datacom). |
| POST api/ScanPack/sendXML |
Provides XML from Sphere Consent process for regulatory system update, (restricted datacom). |
| POST api/COA/sendXML |
Provides XML from Sphere Consent process for regulatory system update, (restricted datacom). |
Dog
Dog Services.
| API | Description |
|---|---|
| GET api/Dogs/Owner/{ownerNo} |
Provides Dogs information for Owner number (restricted datacom). |
| GET api/Dog/Location?st={st}&mode={mode} |
Provides list of top 14 potential Address along with Property ID (integer). For a Dropdown list where best match is dynamic derived by providing a partial address as per parameter. Default mode is ‘startswith’ |
| GET api/Dog/{dogNo} |
Provides Dog information for a single Dog Id Number (restricted datacom). |
| PUT api/Dog/{dogNo} |
Update dog information (restricted datacom). |
| PUT api/Dog/Remove/{dogNo} |
Advice information for death of individual dog (restricted datacom). |
| GET api/Dog/Contact/{ownerNo} |
Provides the contact details for a dog owner (restricted datacom). |
| PUT api/Dog/Contact/{ownerNo} |
Update contact (owner) information, currently phones and email only. (restricted datacom). |
| GET api/Authenticate/Dog/{key1}/{key2} |
Provides Dog owner authentication via invoice (restricted datacom). |
| GET api/Dog/Classification |
Provides dropdown list of Dog Classifications. |
| GET api/Dog/DropDown/Colour |
Provides dropdown list of Dog Colours. |
| GET api/Dog/DropDown/Breed |
Provides dropdown list of Dog Breeds. |
| GET api/Dogs/Owner/{ownerNo}/AccountInfo |
Provides Dog Owner Account Info (restricted datacom). |
| GET api/Dogs/Owner/{ownerNo2}/AccountInfo |
Provides Debtor Account Info for Greg (restricted datacom). |
Inspection
Used for Datascape Mobile Capture (Online Inspections)
| API | Description |
|---|---|
| POST api/FCP/sendXML |
Mobile Inspection Integration Controller Generic xml identification with uses of Root Element |
| POST api/Form/sendXML |
Mobile Inspection Integration Controller Generic xml identification with uses of Root Element |
| GET api/Alcohol/PremiseNameList |
Provides dropdown for Premises names. |
| GET api/GetComplianceScheduleDetail/All |
Provides dropdown for CS Premises names and then fills the required mobile inspection fields |
| GET api/GetComplianceScheduleDetail/{Ram_Id} |
Provides dropdown for CS Premises names and then fills the required mobile inspection fields |
RID
Contractor
| API | Description |
|---|---|
| POST api/Contractor/Veolia |
No documentation available. |
| GET api/GetContractors/{contactId} |
Provides the contact details (from Hubble site/corp/healthsafety) for Health and Safety - Contractors and Suppliers (restricted datacom). |
| GET api/GetContractors/{fromId}/{toId} |
Site: health and Safety, list item: Contractors and Suppliers Note, Web API includes built-in support for JSON, response auto parses this Model based on header attributes Accept='application/json' (response returned) and Content-Type='application/json' request post is expected as json |
| GET api/GetContractors/All |
No documentation available. |
Miscellaneous
Miscellaneous Website Services
| API | Description |
|---|---|
| GET api/StreetAddress?st={st}&mode={mode} |
Provides list of top 12 potential Address along with Property_ID as a valid return integer. Dropdown list, best match, can be dynamic derived by providing a partial address as parameter. Default mode is startswith. |
| GET api/AddressProperty?st={st}&mode={mode} |
Provides list of top 12 potential Address along with Property_ID as a valid return integer. Dropdown list, best match, can be dynamic derived by providing a partial address as parameter. Default mode is startswith. |
| GET api/FoodGrade/{mode}/{search} |
Provides list of Food Premises and Grades. |
| GET api/FoodGrade?mode={mode}&search={search} |
Provides list of Food Premises and Grades. |
| GET api/Descriptor/{descriptorType} |
Access PR Descriptors |
| GET api/AlcoholWorkday/{eventDate} |
Alcohol Is over or equal to 20 Working Days false = over 20 work days and requires a Waiver section 137 sale of Alcohol Act 2012 |
| GET api/isEventOver20Workday/{eventDate} |
Alcohol Is over or equal to 20 Working Days false = over 20 work days and requires a Waiver section 137 sale of Alcohol Act 2012 |
| POST api/StreamToHubble/RamId/{ram_Id}/{att_Id} |
Testing for file stream and retry failed Hubble processes |
| POST api/StreamToHubble/{sphareRefNo}/{ram_Id}/{att_Id} |
Testing for file stream and retry failed processes |
Rates
| API | Description |
|---|---|
| GET api/Rates/Balances/{property_no}/{notice_no} |
Use to return Rates Instalment and Annual Balances for a property ID. A Notice number must also be supplied for verification (restricted datacom). |
| POST api/rates/Confirmed |
Provides Payment Confirmation, Expects: Form Post multipart parameters (restricted datacom). |
Forms
| API | Description |
|---|---|
| GET api/Form/Infringement/Officers |
Provides list of infringement officers (restricted datacom). |
| GET api/Inspection/Reference/{group}/{category} |
Provides Inspection form with ram_id and description |
| GET api/Form/Infringement/Offence/{type} |
Provides list of offences |
| GET api/Form/Infringement/Offence?type={type} |
Provides list of offences |
| GET api/Inspection/Premise/Detail/{externalReference} |
Provides inspection details for premise (interface 1: Retrieve Premises Details). |
| POST api/Form/Infringement/Notice |
Provides Infringement Notice data insert, (restricted datacom). |
| GET api/Inspection/BookingCategory |
Provides List of Inspection Booking Categories. |
| GET api/FCP/PendingBookings/{category} |
Provides Inspection form with ram_id and description, (restricted datacom). |
| GET api/PendingBookings/{category} |
Provides Inspection form with ram_id and description, (restricted datacom). |
| POST api/FCP/PendingBooking/Status |
Provides Inspection form with ram_id and description, (restricted datacom). |
| GET api/FCP/Premise/Detail/{activitityCategory}/{externalReference} |
Provides inspection details for premise (interface 1: Retrieve Premises Details). /api/FCP/Premise/Detail/fspAudit/WGN000165.01, -, |
| POST api/Forms |
Provides XML Inspection inserts. |
Payments
Payment Services
| API | Description |
|---|---|
| POST api/Payment/Confirmed2 |
Testing for new payment Integration TestPost ie. note to replace/supersede API(legacy) WDCPaymentService Intergration |
| POST api/Payment/Confirmed3 |
No documentation available. |
| POST api/Payment/Confirmed |
Provides Payment Confirmation, Expects: Form Post multipart parameters (restricted datacom). |
| GET api/Payment/AccountDetail/{paymentType}/{referenceNo}?referenceNo2={referenceNo2} |
Provides payment account details based on a payment type and matching reference number (restricted datacom). calls SP usrApiGetPaymentDetailByType type, ref1, ref2 |
| GET api/Payment/AccountDetail/{paymentType}/{referenceNo}/{referenceNo2} |
Provides payment account details based on a payment type and matching reference number (restricted datacom). calls SP usrApiGetPaymentDetailByType type, ref1, ref2 |