-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger-v3.yml
6779 lines (6644 loc) · 319 KB
/
swagger-v3.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Property Location Service Plus PLSplus QG Version -REST
description: |
This Provides the starting point for using the QG (Qld Govt) version of the Property Location Service (PLS) Plus RESTful Implemenation. The service has a sister implementation using SOAP technology. In this document the RESTful version will always be assumed unless specifically stated as the SOAP implementation.The document describes the service functions and provides a roadmap for implementing this functionality into user systems.
Access to PLSplus-QG is recommended for all government agencies.
Physical address validation is free of charge, however, users are responsible for their own implementation and supporting services. Application support services are only available to the core service by DNRME.
The PLSplus-QG service will validate Australian addresses by including matches across unit number, street number, street name, street type, locality, state and postcode. The solution provides users with a selection of address candidates to pick from in the case where there is no exact match. The returned confidence on addresses is mapped as per Table 1 in Section 11.4. A fast AutoComplete address function is available in PLSplus for Queensland addresses. The QG version extends the Public version by the addition of validation of interstate addresses as well as ABS statistical meshblock information for all Australian addresses.
PLSplus uses addressing standards AS4819 and AS4590 as its base.
There may be future enhancements, but at this stage it meets the initial specifications as an address service for point of entry confirmation of physical addressing. Any coding to ‘clean up’ returned candidate addresses needs to be performed by client applications consuming the service.
## 1) Data Source
The Queensland Address Management Framework (QAMF) dataset is used to populate the service data source for Queenland addresses. The dataset is maintained by the Department of Natural Resources and Mines (DNRME) and updated nightly for use by client applications. Interstate addresses are provided by a third party (paid) service and use the GNAFF.
The QAMF is the primary source of property location addressing information for Queensland. It is location centric, meaning that addresses can be geocoded against a variety of locations, eg centroid of the property, centroid of the street alignment, entrance of the property and the main building. It is the point of truth for addressing in Queensland and is continually maintained from data supplied by local government authorities (LGA’s).
Attributes currently stored include:
* Lot Number
* Plan Number
* Geocode
* Geocode Type
* Unit Type
* Unit Number
* Level
* Building/Complex Name
* Street Number
* Street Name or Property Name
* Street Suffix
* Street Type
* Locality
* State
Postcode data is not part of the QAMF but is available from the PLSplus service.
Note: Users should be aware that not all properties have an address. These include properties where the LGA does not hold an interest, eg a National Park or unallocated Crown Land. Some properties (like gated or Indeginous communities) have multiple addresses within them. Multi-
Address properties are catered for in PLSplus.
Interstate addresses is sourced from The GNAF (Geocoded National Address File) which has the same Attributes minus the Plan Number of the property.
## 2) Functionality Available
Under a whole of government agreement approved users may access the following PLS plus functionality for the exclusive benefit of the approved user (Licensed Purpose), free of software licensing costs:
* Address validation against the QAMF
* Appending latitude/longitude to an address using the QAMF
* Appending lot/plan information to an address using the QAMF
* Looking up addresses in the QAMF from a given lot and plan number
* Looking up addresses in the QAMF from a given latitude and longitude
* Australian postcodes
* Australian mesh blocks (ASGS2011)
* Failover to a 3rd party provider
* Interstate address validation through a 3rd party provider.
Batch processing on the server side is not offered at this point in time. The Qld Geocoder application, used for batching up to 5000 addresses. LotPlans or geocodes, is available at http://geocode.information.qld.gov.au. The application requires a comma delimited (CSV) file of addresses and uses the ParseAddress, ValidateLotPlan or ValidateCoordinate operations. Full documentation is available at the above URL.Individual validations are also available with the application.
## 3) Support Services
DNRME will supply:
* Business support: described as granting access to the individual services and general business requests, and
* Technical support: described as support for the physical environment and associated hardware.
Integration with applications, training and other support services within the user’s area is the responsibility of each user.
## 4) Service Security
The QG versions of the service is made available to approved authenticated users, both internal to DNRME and other Queensland Government agencies.
## 5) Obtaining the Service
The QG version of the service requires authentication by way of a username and password.
Access to the QG service and provision of credentials can be obtained by sending a request to [email protected] and providing the following information:
* Preferred username*: (eg plspQr-floodinfo)
* Project or application name: (eg Floodinfo)
* Service requested - REST Company/Department Name
* Responsible Officer Name:
* Responsible Officer Email: (Must be shared mailbox)
* Responsible Officer Phone:
* Secondary Contact Name:
* Secondary Contact Email:
* Secondary Contact Phone:
* Give an indication of the category your applications fall into:
* Life Threatening - Used for emergency purposes (24/7 needed)
* Critical - Used for business purposes business hours (counter or online)
* Non Critical - Used for business purposes
Note: the user name will start with plspQr_ for QG version users.
### Logging and Auditing
Logging and auditing usage of the service helps by providing the metrics for determining requirements for enhancements to the service, infrastructure and data.
* To ensure an accurate record of usage by applications, **please request an account for each separate project or application**.
* **Do not pass the credentials to other staff for use in other projects or applications**.
Following approval from the delegated officer, credentials for the required service/s will be provided.
If the following message is returned from a request it may be due to authentication problems:
"status": "error", “This request was rejected due to a violation. Please contact [email protected], and provide this reference ID: 12719710694116814232"}
Take a note of the time of the request and include it and your username in an email to [email protected] for assistance.
## 6) Licensing
The Property Location Service Plus – QG is offered under a Creative Commons Attribution licence. To view a copy of this license visit https://creativecommons.org/licenses/by/4.0/. The Department requests attribution in the following manner: Natural Resources and Mines, Queensland Government, Property Locations Service Plus - QG, licensed under Creative Commons Attribution.
## 7) Charging and Pricing
In this release of the PLSplus-QG there is no intention to develop a charge for Government departments. If, in subsequent releases additional functionality is added, charging for the additional functionality may be considered.
## 8) Service Availability
<table>
<thead>
<tr>
<th>Support Category</th>
<th>Hours of Operation</th>
<th>Support Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Business Support</td>
<td>8am – 5pm Business Days *</td>
<td>Business support is described as granting access to the individual services and general business requests.</td>
</tr>
<tr>
<td>Technical Support</td>
<td>8am – 5pm Business Days *</td>
<td>Technical support is described as support for the physical environment and associated hardware.</td>
</tr>
<tr>
<td>Service Availability</td>
<td>Approaching 24 x 7</td>
<td>Dependent upon scheduled system maintenance and hardware or software failur.</td>
</tr>
</tbody>
</table>
\* Business days mean a day that is not a Saturday, Sunday, Queensland Public Holiday, or day between 25 December and 1 January inclusive.
Should the service fail outside business or technical support hours, the service may not return until the next business day.
## 10) PLSplus-QG at a glance
* PLSplus is based on Addressing Standards AS AS4819 and AS4590. Users will see major changes in the schema of the responses from original Land XML format.
* The service requires Method Type :POST and Payload Type :application/json
* Postcodes (where in use) are returned with addresses.
* Unit types and Building Level information has been implemented (though not extensive in
addressing database). A list of unit types is available in Section 11 of this document.
* Address and geocode type are returned with the response. (PC parcel centroid, BC Building
Centroid, PAP Property Access Point etc)
* Confidence values are always returned (see confidence levels Section 11.3.1)
* A result element called “Metadada” is returned. It shows the “FullAddressString” for Physical
and Service addresses as well as the “DeliveryTypeCode” and “DeliveryIdentifier” for service
addresses.
* Addresses are either Physical (real address) or Mail Service Address (available in PLSplus-
Premium) and shown respectively.
* <PhysicalAddressIndicator>Y</PhysicalAddressIndicator>
* <PhysicalAddressIndicator>N</PhysicalAddressIndicator>
Postcodes where available are supplied as part of the address response. It should be remembered that Postcodes do not form part of an address but are for Australia Post Delivery purposes. There may be some descrepancies with postcode where Australia Post has deviated from approved Locality boundaries. Please note that some parts of Qld (and Australia) do not have a postcode. In these cases the Postcode element is not included in the response.
## 10) Versions of the Property Location Service Plus
The PLSplus has three versions; PLSplus-Public, PLSplus-QG and PLSplus-Premium (DNRME users only). This document covers the PLSplus-QG version.
This is the Qld Government version of the service. In addition to the operations detailed in Section 12 this version of the service has failover and Interstate address validation. The inclusion of Mesh Blocks (ASGS2011) data is available for address confidence level of 85 or greater. See Sect 15 for confidence mapping.
## 11) Elements in ParseAddress and ValidateAddress functions
See Schema Components for element details
## 12) Operations available within PLSplus
The primary purpose of the Property Location Service plus is to validate uncertain or incomplete information about a parcel (identified by a street address, lot on plan description, geographic coordinate or address string).
This service provides the following operations:
* ValidateAddress ^1
* ParseAddress ^1
* ValidateLotPlan ^2
* ValidateCoordinates ^2
* AutoCompleteAddress ^2
^1 All Australian physical addresses with meshblock option (Include) are available for PLSplusQG users.
^2 Only information relating to Qld Properties and addresses are available for these operations.
A successful validation returns other information, such as address, lot on plan, coordinates, and matching confidence level.
Tip: Using the “AutoCompleteAddress” operation will always deliver a list of up to 50 valid Queensland addresses. Your application could select any of these returned addresses and be passed to ParseAddress and make use of the quick “optimistic” search.
## 13) Definitions of Standard Outputs
### 13.1) Lot and Plan Number
The Lot and Plan Number follows the QSIIS Land Parcel Identification Standard. This standard provides a consistent method for uniquely identifying all land parcels in Queensland. In the context of this document, a parcel is understood to be a bounded area in which an interest relating to the land exists or will exist. It is also recognised that such a parcel (or bounded area) may have more than one interest associated with it. Any secondary interest (strata plans) can be validated with PLSplus.
### 13.2) Street Address
The following table shows a mapping between the sub-elements within the Address element and the Address Details of Australian Standard AS4590 – Interchange of Client Information. AS 4590 deals with the interchange of client information - client information such as personal and addressing details - data that is routinely collected by many organisations from their customers/clients and used for contact, logistics and business activity. Address Details are shown in Section 5 of AS 4590.
## 14) Acceptable Abbreviations
### 14.1) Road Type Abbreviations
See Component `Road` -> `TypeCode` for full list in its description
TypeCode is the Abbreviation
### 14.2) Acceptable State Names and Abbreviations
Only the correct spelling is assumed and only these combinations (case sensitive) below:
* Australian Antarctic Territory – `AAT`, `A A T`
* Australian Capital Territory – `ACT`, `A C T`
* NewSouthWales –`NSW`, `N S W`
* Northern Territory – `NT`, `N T`
* Queensland – `Q`, `Qld`
* South Australia – `SA`, `S A`
* Tasmania – `TAS`
* Victoria – `VIC`
* Western Australia – `WA`, `W A`
#### Tips and Tricks
1. Not including a “State” in an address, incorrectly spelling “State” name or “State” abbreviation will be interpreted by PLSplusQG as a “Queensland address”.
2. Any other State name or abbreviation will be interpreted as a Qld address and invoke the Soundex routines and supply surprising results.
3. Do not use a full stop “.” in any abbreviation.
4. Postcode can form part of an address.
## 15) Confidence Level
The Confidence Level is a value between 0 – 100 returned in the response for ValidateAddress and ParseAddress requests. It gives the user an understanding of the validity of the requested address. In the response the element name is “Confidence” and it is a value that represents the categories listed in Section 11.3.
* No confidence is displayed for ValidateLotPlan however a “Count” of 1 could be taken as valid of a confidence of 100.
* No confidence is displayed for ValidateCoordinate operation which can, in some situations, be problematic, eg high rise building units where all geocoords from the building are projected to ground level. Meshblock information can be “Included” with the request for any service where the option is available.
## 16) Service Definitions
See path functions for deetails
## 17) Response Elements
See Schemas objects for elements and descriptions
## 18) Valid metacharacters allowed in request
## 19) Error responses
### 19.1) Errors
All errors for all operations will be wrapped in the JSON element. Faults contain the below elements
<table><thead>
<tr><th>Name</th><th>Type</th><th>Description</th></tr>
</thead><tbody>
<tr><td>reference id</td><td>String</td><td>Id that can be referenced in an incident ticket to aid the support team in identifying the cause of the error</td></tr>
<tr><td>faultCode</td><td>String</td><td>Fault code (e.g. InvalidRequest)</td></tr>
<tr><td>faultString</td><td>String</td><td>Fault message</td></tr>
<tr><td>time</td><td>String</td><td>Time the error occurred</td></tr>
</tbody></table>
The following outlines the errors associated with each of the HTTP Response Code HTTP 200
For errors returned with a HTTP 200 status, the JSON response payload will contain the below elements.
* Type - Description
* `InvalidRequest` - Occurs when one or multiple fields contain invalid data. Refer to the faultString for the specific field that’s causing the error.
* `ValidationError` - Occurs when payload is missing a required element
### 19.2) Fault (HTTP) Codes
The following highlights other HTTP codes and the possible causes behind the errors. These errors are returned from the transport layer
* Code - Description
* `400` - Returned when fields in the JSON payload is incorrectly defined
* `401` - Returned due to unauthorised access to the service
* `403` - Returned due to not having enough privileges accessing the
service. Contact the OpenData if you believe this is incorrect.
* `404` - Resource not found
* `405` - Request method type is not allowed. All RESTful operations only allow the HTML POST method
* `415` - Request payload media type is invalid. All RESTful operations only allow application/json as the media type
* `422` - An unexpected error occurred on the server. Contact OpenData with the referenceId to further investigation
* `500` - This error occurred due to the request not conforming to the request format and an error such as an InvalidRequest or
ValidationError is returned.
* `503` - The underlying system is unavailable. Contact OpenData with the
massage id and the time of the error will allow OpenData to diagnose the issue
1. **Service Not Available**
Response is given if a component of the operation is unavailable or there is an unexpected system failure.
2. **The requested operation was rejected + Message**
Response is returned if the any of the elements are outside of the following parameters 0-9, A-Z, &, /, (, ), ‘, -, #
* No wildcards can be used
3. **Lot Number Invalid shown as**
"faultCode": "InvalidRequest", <br/>
"faultString": "Lot Number Invalid",
Response is returned if the lot number is either null or does not match with the plan number
4. **Plan Number Invalid**
"faultCode": "InvalidRequest",<br/>
"faultString": "Plan Number Invalid",
Response is given when the plan number uses any characters outside A-Z and 0-9 .
### Some example errors
1. **Service Not Available**
Response is given if a component of the service is unavailable or there is an unexpected system failure.
2. **InvalidRequest + Message** (“This request was rejected due to a violation.....)
Response is returned if the any of the elements are outside of the following parameters 0-9, A-Z, &, /, (, ), ‘, -, # See allowed Metadata Character valid list
* No wildcards can be used.
* The message may contain “Street Name”, “Locality” or “Local Government” invalid’.
3. **No Matches found**
A “ResultCount”: “0” means no matches were found
4. **Too Many Results**
Response is given when the request returns more than 500 responses.
contact: {}
version: '1.0'
servers:
- url: https://information.qld.gov.au/service/Addressing/ValidationService/PLSplusQG/rest
description: This is the production endpoint
variables: {}
- url: https://uatplsp.information.qld.gov.au/service/Addressing/ValidationService/PLSplusQG/rest/
description: For development use this UAT endpoint
variables: {}
security:
- BasicAuth: []
paths:
/ValidateAddress:
post:
tags:
- PLSp-QG
summary: ValidateAddress
description: |
# Design Requirements
The ValidateAddress operation validates the existence of a requested address and returns possible addresses that best match the search criteria if no identical match is found.
The ValidateAddress operation also geocodes the address and returns the geocoded coordinates available in the QAMF database (and Interstate for plusQG users). Parcel information is available for Qld addresses only.
* MeshblockOption is mandatory and must be either “Include” or “Exclude” (Case sensitive).
* RoadName is broken into three fields (NAME, TYPE and SUFFIX). The “NAME” is the only
other mandatory field in the request.
* RoadName can consist of a “name”,“name and type” or “name and type and suffix”.
* McCaul
* McCaul Street
* McCaul Street North
* The ValidateAddress operation supports alias locality names (adjoining, neighbouring or "broader area" localities)
* The ValidateAddress operation flexibly matches road type, road suffix, locality, postcode and local government. Flexibility includes:
* The ability tohandleabbreviations(roadtypes,suffix).
* The ability to locate road names that sound similar (first uses its own logic before trying a soundex or similar logarithm).
* Road names are first tested against locality/locality alias before soundex is used.
* The ability to support alias or vanity neighbourhood locality names.
* Ability to recognize Building Level Types and identifiers
* Ability to recognise Complex/Building names
* Postcodes (where they exist) are supported for all requests.
* If a street name (only), without a street type and street suffix is requested, the operation returns all street types for the street name plus all the street suffixes for that street name. The results would the be as such:
* All street types (and street suffixes) are found for the requested street name and then all locations are returned for that street name, type (and street suffixes). Note that if more than the predefined maximum number of 500 addresses is returned, the response would be “too many results found”.
* If a street number and street name are requested (but no street type), the operation should find all street types (and street suffix) for the street name and the results would be the following:
* The street type (and street suffix) is found for the street name.If a match can not be found for the street number – all locations for that street name (and street suffix) are returned. Note that if more than a predefined (user definable) maximum number of addresses is returned, the response would be “too many results found”.
* If only a building name is requested. The operation will find all building names in the dataset that have a name that best matches (including soundex possibilities) of the requested property name, if there is not an exact match.
* The following Unit types (steadily increasing in QAMF) are catered for
* APT(Apartment),FY(Factory),F(Flat),MB(MarineBerth),PTHS(Penthouse),OFF (Office), RM (Room), SHED (Shed), SHOP (Shop), SITE (Site), SL (Stall), SE (Suite), U (Unit), VLLA (Villa), WE (Warehouse).
* The unit number and street number may be a range of values. Following are examples:
* 12-24
* 12A-24
* 12A-24B
* The ValidateAddress operation applies flexible matching of addresses. The following is the priorities/process that are followed when determining the staus of an address.
### Address Logic Process flow
* Optimistic validation:
* Assumetheaddressexistsandsearchdatabaseforexactmatchonstreetnumber,
street name and locality
* Road based – fuzzy match on roads within locality
* Road based – fuzzy match on roads within locality alias and postcodes
* Full validation (the original process from original PLS with some modifications to improve results – See below for detail)
* Search by:
* Roadname,type,suffix,locality,localauthority
* Roadname,locality,localauthority
* Roadname,locality
* Roadname,locality,localauthority(soundexonroadname)
* Roadname,locality(soundexonroadname)
* Roadname,locality(soundexonboth)
* Roadname
* Roadname(soundex)
* If an address does not exact match the requested address the process will follow the following logic
* Disregard the unit number and search on street number, street name
(including street type and street part), locality (and alias Locality) and local
government.
* Disregard the unit and street number and search on the street name (including street type and street part), locality and local government.
* Disregard the unit and street number, street type and part and search on street name,
locality and local government.
* Disregard the unit and street number, street type and part and locality and search for the requested street name within the local government or adjoining localities.
* Disregard the unit number, street number, street type, street part, locality and local government and search on the requested street name.
* Search for the street name with soundex only
* Search for the street name with soundex and local government name.
* Search for the street name with soundex, locality with soundex and local government name.
* Search for the street name with soundex, streettype, locality with soundex and local government name.
* Search for the street name with soundex, streettype, streetpart, locality with soundex and local government name.
* Search for the street number,street name with soundex, street type, street part,
locality with soundex and local government name.
* Search for unit number, street number, street name with soundex, street type, street part, locality with soundex and local government name.
The PLSplusQG version offers interstate addressing and the “state” (other than Qld) must be specified for it to be interpreted as a non Qld adrdess. Interstate names must match the list of interstate abbreviations in Section 15.2.
**For endpoints and Json Request example see Appendix Technical Information**
Notes about request
* Physical Addresses only
* Meshblock Option (“Include” or “Exclude”) must be stipulated. (case sensitive)
* At least a Street Name or Building Name must be supplied
* No wildcards allowed
* All elements are case sensitive
* If both the locality and local government are entered the locality must be within the local
government
* If only a local government name is entered the localities within the local government are
determined and used in the search
* A list of locality and local government names recognised by the service can be provided on
request. Be aware that the list changes regularly.
* “Alias” Localities are used as substitutes for adjoining or “unapproved” communal named
localities. Localities sharing the same postcode are also used as “aliases”.
* State name is “Qld” unless otherwise specified.
operationId: ValidateAddress
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PLSPlus_ValidateAddress_InputMessage'
examples:
first:
summary: 'example request 1 meshblock excluded'
value:
ValidateAddress:
request:
MeshblockOption: Exclude
LevelType: L
LevelNumber: D
UnitType: Unit
UnitNumber: '201'
BuildingName: ''
NumberFirst: '160'
NumberSuffixFirst: ''
NumberLast: ''
NumberSuffixLast: ''
Road:
Name: Denham
Type: St
Suffix: ''
LocalityName: TOWNSVILLE
StateName: QLD
PostCode: '4810'
second:
summary: 'example request 2 meshblock included'
value:
ValidateAddress:
request:
MeshblockOption: Include
LevelType: L
LevelNumber: D
UnitType: Unit
UnitNumber: '201'
BuildingName: ''
NumberFirst: '160'
NumberSuffixFirst: ''
NumberLast: ''
NumberSuffixLast: ''
Road:
Name: Denham
Type: St
Suffix: ''
LocalityName: TOWNSVILLE
StateName: QLD
PostCode: '4810'
third:
summary: 'example 3 - lots of results'
value:
ValidateAddress:
request:
MeshblockOption: Exclude
LevelType: ''
LevelNumber: ''
UnitType: Unit
UnitNumber: ''
BuildingName: ''
NumberFirst: '204'
NumberSuffixFirst: ''
NumberLast: ''
NumberSuffixLast: ''
Road:
Name: margert
Type: St
Suffix: ''
LocalityName: brisbane city
StateName: QLD
PostCode: '4000'
required: true
responses:
'200':
description: Successfully retrieved the response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PLSPlus_ValidateAddress_OutputMessage'
examples:
first:
summary: 'example response 1 meshblock excluded'
value:
ValidateAddressResponse:
ValidateAddressResult:
ResultCount: '1'
Results:
Result:
PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T07:59:01.4702911+10:00'
- Name: FullAddressString
Value: '146-160 DENHAM ST, TOWNSVILLE CITY QLD 4810'
Address:
RoadNumber:
First: '146'
Last: '160'
Road:
Name: DENHAM
TypeCode: ST
Locality: TOWNSVILLE CITY
State: QLD
Postcode: '4810'
Parcel:
Lot: '2'
Plan: RP743230
LocalGovernmentArea:
Code: '7010'
Name: TOWNSVILLE CITY
Geocode:
TypeCode: PC
Latitude: '-19.25654167'
Longitude: '146.81576274'
Confidence: '93'
second:
summary: 'example response 2 meshblock included'
value:
ValidateAddressResponse:
ValidateAddressResult:
ResultCount: '1'
Results:
Result:
PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T07:59:50.4308178+10:00'
- Name: FullAddressString
Value: '146-160 DENHAM ST, TOWNSVILLE CITY QLD 4810'
- Name: MESHBLOCK_CODE
Value: '30541711000'
- Name: MESHBLOCK_CATEGORY
Value: Commercial
- Name: STATISTICALAREALEVEL1_MAINCODE
Value: '31802149022'
- Name: STATISTICALAREALEVEL1_7DIGCODE
Value: '3149022'
- Name: STATISTICALAREALEVEL2_MAINCODE
Value: '318021490'
- Name: STATISTICALAREALEVEL2_5DIGCODE
Value: '31490'
- Name: STATISTICALAREALEVEL2_NAME
Value: Townsville City - North Ward
- Name: STATISTICALAREALEVEL3_CODE
Value: '31802'
- Name: STATISTICALAREALEVEL3_NAME
Value: Townsville
- Name: STATISTICALAREALEVEL4_CODE
Value: '318'
- Name: STATISTICALAREALEVEL4_NAME
Value: Townsville
- Name: CAPITALCITYSTATISTICALAREA_CODE
Value: 3RQLD
- Name: CAPITALCITYSTATISTICALAREA_NAME
Value: Rest of Qld
- Name: STATE_CODE
Value: '3'
- Name: STATE_NAME
Value: Queensland
- Name: AREAALBERS_SQM
Value: '30269.851914'
Address:
RoadNumber:
First: '146'
Last: '160'
Road:
Name: DENHAM
TypeCode: ST
Locality: TOWNSVILLE CITY
State: QLD
Postcode: '4810'
Parcel:
Lot: '2'
Plan: RP743230
LocalGovernmentArea:
Code: '7010'
Name: TOWNSVILLE CITY
Geocode:
TypeCode: PC
Latitude: '-19.25654167'
Longitude: '146.81576274'
Confidence: '93'
third:
summary: 'example 3: lots of results'
value:
ValidateAddressResponse:
ValidateAddressResult:
ResultCount: '139'
Results:
Result:
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4673911+10:00'
- Name: FullAddressString
Value: 'UNIT 128 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '128'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '128'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4673911+10:00'
- Name: FullAddressString
Value: 'UNIT 129 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '129'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '129'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4673911+10:00'
- Name: FullAddressString
Value: 'UNIT 130 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '130'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '130'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4723852+10:00'
- Name: FullAddressString
Value: 'UNIT 131 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '131'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '131'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4723852+10:00'
- Name: FullAddressString
Value: 'UNIT 133 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '133'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '133'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4773880+10:00'
- Name: FullAddressString
Value: 'UNIT 134 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '134'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '134'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4773880+10:00'
- Name: FullAddressString
Value: 'UNIT 135 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '135'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '135'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4823891+10:00'
- Name: FullAddressString
Value: 'UNIT 136 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '136'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '136'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4823891+10:00'
- Name: FullAddressString
Value: 'UNIT 137 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '137'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '137'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4823891+10:00'
- Name: FullAddressString
Value: '212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '9999'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.47202306'
Longitude: '153.02830205'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4873893+10:00'
- Name: FullAddressString
Value: 'UNIT 90 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '90'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '90'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4873893+10:00'
- Name: FullAddressString
Value: 'UNIT 87 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '87'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '87'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4923892+10:00'
- Name: FullAddressString
Value: 'UNIT 88 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address:
RoadNumber:
First: '212'
Road:
Name: MARGARET
TypeCode: ST
Unit:
TypeCode: U
Number: '88'
Locality: BRISBANE CITY
State: QLD
Postcode: '4000'
Parcel:
Lot: '88'
Plan: SP143450
LocalGovernmentArea:
Code: '1000'
Name: BRISBANE CITY
Geocode:
TypeCode: PC
Latitude: '-27.4721281'
Longitude: '153.02848015'
Confidence: '85'
- PhysicalAddressIndicator: 'Y'
MetaData:
- Name: Timestamp
Value: '2021-04-29T15:50:01.4923892+10:00'
- Name: FullAddressString
Value: 'UNIT 89 212 MARGARET ST, BRISBANE CITY QLD 4000'
Address: