REST API 

The information on this page is intended for developers and programmers that may wish to extend or improve on the National Broadband Map.   The content on this page assumes knowledge of RESTful APIs and web services.

A core part of the National Broadband Map is the ability for data to be accessed in a number of ways.   This includes the RESTful server from which data can be read and manipulated outside of the mapping application via carefully constructed URLs.

Some Examples

http://broadbandmap.govt.nz/api/v1/DemandPoint/14
Shows an existing demand point, the output is XML by default.

http://broadbandmap.govt.nz/api/v1/DemandCategory/7
Shows an existing demand category, the output is XML by default.

http://broadbandmap.govt.nz/api/v1/DemandCategory/7.json
Shows an existing demand category with JSON extension.

http://broadbandmap.govt.nz/api/v1/DemandCategory/1/Points.kml
Shows all demand points for a category, the output is KML.

Data Formats

Currently data can be exposed as XML, KML, CSV and JSON.

Security and Permissions

Data can be modified, added and deleted via the RESTful API.  General users have read only access to the data.   This is controlled via a user and groups based permissions sytem.   Approval to add, modify or delete data via the RESTful API lies with the Ministry of Economic Development.

Demand Categories

These are the demand categories that may be used in conjunction with the RESTful API.  They are subject to change without notice. 

Parent Category
Number
Category
Number
Category Name
0 1 Government
0 2 Education
0 3 Local government
0 4 Business
4 5 Rental, Hiring and Real Estate Services
4 6 Information Media and Telecommunications
4 7 Financial and Insurance Services
4 8 Other Services
4 9 Accommodation
0 10 Health
4 11 Retail Trade
4 12 Manufacturing
4 13 Education and Training
4 14 Professional, Scientific and Technical Services
4 15 Property Operators and Real Estate Services
4 16 Health Care and Social Assistance
4 17 Food and Beverage Services
4 18 Wholesale Trade
4 19 Agriculture, Forestry and Fishing
4 20 Arts and Recreation Services
4 21 Transport, Postal and Warehousing
4 22 Construction
2 23 Early Childhood
2 25 Tertiary
10 26 Pharmacy
10 27 Hospital
10 28 GPs and Medical Centres
10 67 A&E / After Hours Medical
1 41 Accident Compensation Corporation
2 57 Activity Centre
0 65 Community
2 85 Composite (Year 1-10)
2 52 Composite (Year 1-15)
2 46 Contributing (Year 1-6)
2 91 Correspondence School
2 92 Correspondence School
10 68 Dental
1 31 Department of Conservation
1 33 Department of Corrections
1 42 Department of Internal Affairs
1 37 Department of Labour
10 69 DHB
10 70 Diagnostic Services
10 58 e-Health Initiatives
10 71 Education / Medical Training
1 30 Fire Stations
2 45 Full Primary (Year 1-8)
1 35 Housing New Zealand Corporation
1 39 Inland Revenue Department
10 72 Intergrated Family Health Centre
2 47 Intermediate (Year 7 & 8)
2 89 Kura Teina
2 49 Kura Teina - Primary
2 50 Kura Teina - Primary (Year 1-8)
2 51 Kura Teina รป Composite (Year 1-15)
10 73 Maori Health Provider
65 66 Marae
1 36 Ministry of Education Office
1 32 Ministry of Social Development
1 40 New Zealand Customs Service
1 34 New Zealand Food Safety Authority
10 74 NGO
10 75 Not for Profit / Registered Charity
10 76 Optometrist Site
10 77 Other
1 43 Other Government
10 78 Pacific Health Provider
10 79 PHO
1 29 Police Stations
1 38 Public Trust
10 80 Respite / Palliative Care
10 83 Rest Homes
2 48 Restricted Composite (Year 7-10)
2 88 Restricted Composite (Yr 7-10)
10 81 School Dental
2 90 Secondary (Year 11-15)
2 87 Secondary (Year 7-10)
2 53 Secondary (Year 7-15)
2 54 Secondary (Year 9-15)
2 55 Special School
10 82 Specialist Services
2 56 Teen Parent Unit

Disclaimer

Developers' and other users' attention is drawn to the terms of the disclaimer.