Place API
Testing
Chorus NZ is committed to making integration with our APIs easy and robust and we are available to provide support for your development and testing.
For information on access and setup requirements for our emulation environment (EMMA) for testing the Fibre APIs, see Emulation Environment (EMMA).
On this page, you will find information on suggested test cases and test data.
Test cases
As with any software development, Chorus encourages you to test your application with both positive and negative scenarios. The test cases we've provided here are for your convenience, but are not intended to be comprehensive.
Some test cases may not apply to your use of the API. Please extend these cases with test cases that are specific to your business and use cases.
Comprehensive testing of your application should also include:
- API response time
- different types of requests
- different types of data
- handling errors and exceptions.
Learn more about our error codes
The following suggested test cases are designed to assist you with searching, validating and retrieving details about your customer’s address or location as part of initiating a fibre order.
We can supply specialised test data for the following test cases. To find out more, contact API Support.
| ID | Suggested test case | Expected result | Endpoint |
|---|---|---|---|
| FP1 | Submit a GET places by query search to retrieve all addresses/locations with matching address details to those supplied. | The API will return a 200 response code and all addresses with matching street number, street name and street type. | /places |
| FP2 | Submit a GET places by query search to retrieve all addresses/locations associated with the key based parameter. | The API will return a 200 response code and the associated address to the key based identifier supplied. | /places |
| FP3 | Submit a GET site information by ID search to retrieve site information details about an address/location. | The API will return a 200 response code and the associated ONTs, products, open orders and Chorus network location information. | /siteinformation |
Note: For sample error messages, see the API Specification.
Test data
Postman collection
We have provided a Postman collection file to make it easy to test this API, which includes examples of requests that will generate responses within the EMMA environment. This will also include successful responses and error codes.
Note: You’ll also require your Azure Client ID and Client Secret to obtain a token as part of the global variables. To request access, contact API Support.
The following scenarios are intended as a guide and for use in conjunction with the variable names and values, which must be set prior to running the Postman collection.
| Test Case ID | Scenario | ONTs | Active Products | Open Orders | Active Product owned by RSP |
|---|---|---|---|---|---|
| FP1.1 | Search and locate address/location types: - SDU - MDU/ROW - Level/Apartment/Unit | n/a | n/a | n/a | n/a |
| FP2.1 | Search and locate address/location by key based identifiers: - ONT Serial Number - Product ID - PLSAM ID - TUI ID - Place ID | n/a | n/a | n/a | n/a |
| FP3.1 | SDU - scope and install required at non-greenfield location (New install) | None | None | None | n/a |
| FP3.2 | SDU - scope and install required at greenfield location (New install) | None | None | None | n/a |
| FP3.3 | MDU/ROW - consent required (New install) | None | None | None | n/a |
| FP3.4 | MDU/ROW - consent under action (New install) | None | None | Yes Note: This is as a part of MDU/ROW parcel. | n/a |
| FP3.5 | Intact ONT: - Type 200 - Type 300 - Type 400 - Type 110 - SFP | 1 ONT | No | None | n/a |
| FP3.6 | Active ONTs: - Type 200 - Type 300 - Type 400 - Type 110 - SFP | 1 ONT | Yes | Yes | Yes |
If you have any questions about your test data needs or need to request access, contact API Support for assistance.