Order Feasibility 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 have provided 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 with test cases 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 performing feasibility checks, 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 | Test case | Expected result |
|---|---|---|
| FOF1 | Submit a POST orderFeasibility to query Connect Primary order type in different residential scenarios (no intact ONTs available). | The API will return a 200 response and an order feasibility outcome with reason and code. |
| FOF2 | Submit a POST orderFeasibility to query Connect Primary or Connect Secondary order type in different residential scenarios (with intact ONTs available). | The API will return a 200 response and an order feasibility outcome with reason and code. |
| FOF3 | Submit a POST orderFeasibility to query Connect Additional ONT order type in different residential or business scenarios. | The API will return a 200 response and an order feasibility outcome with reason and code. |
| FOF4 | Submit a POST orderFeasibility to query Transfer Primary or Connect and Replace order type in different residential scenarios. | The API will return a 200 response and an order feasibility outcome with reason and code. |
| FOF5 | Submit a POST orderFeasibility to query Change Offer or Modify Attribute order type in different residential scenarios. | The API will return a 200 response and an order feasibility outcome with reason and code. |
| FOF6 | Submit a POST orderFeasibility to query Disconnect Primary order type in different residential scenarios. | The API will return a 200 response and an order feasibility outcome with reason and code. |
| FOF7 | Submit a POST orderFeasibility to query Connect Primary order type in different business scenarios (no intact ONTs available). | The API will return a 200 response and an order feasibility outcome with reason and code. |
For sample error response 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.
If you have any questions about your test data needs or need to request access, contact API Support.
Note: You’ll also require your Azure Client ID and Client Secret to obtain a token as part of the global variables.
The following common scenarios are intended as a guide and for use with the variable names and values, which must be set prior to running the Postman collection.
Note: These scenarios are all based on Product Offer Zone: UFB and Market Segment: Residential, unless noted. Depending on what products you offer, some scenarios may not apply.
| Test case | Order type | ONTs | Active products | Active product owned by RSP | Site visit | CSE (private or public) | Test case comment |
|---|---|---|---|---|---|---|---|
| FOF1.1 | Connect Primary | None | n/a | n/a | Mandatory | Optional | Full install required |
| FOF1.2 | Connect Primary | None | n/a | n/a | Mandatory | Optional | Greenfield location |
| FOF1.3 | Connect Primary | None | n/a | n/a | Not returned | Not Offered | MDU/ROW consent, design and build required |
| FOF1.4 | Connect Primary | None | n/a | n/a | Not returned | Not Offered | Manual feasibility required |
| FOF1.5 | Connect Primary | None | n/a | n/a | To be determined | To be determined | Site visit to be determined |
| FOF2.1 | Connect Primary | 1 ONT | None | n/a | Optional | Optional | Intact ONT activation |
| FOF2.2 | Connect Primary | 1 ONT | None | n/a | Optional | Optional | Intact ONT activation using tail extension (if applicable) |
| FOF2.3 | Connect Primary | 1 ONT | None | No | Optional | Optional | Intact ONT activation using Voice (if applicable) |
| FOF2.4 | Connect Primary | 2+ ONTs | 2 active | No | Optional | Optional | Multiple Primaries scenario |
| FOF2.5 | Connect Secondary | 1 ONT | 2 active | No | Optional | Optional | Intact ONT activation |
| FOF3.1 | Connect Additional ONT | 1 ONT | 1 active | n/a | Mandatory | Optional | |
| FOF4.1 | Transfer Primary | 1 ONT | 1 active | No | Optional | Optional | |
| FOF4.2 | Transfer Primary | 1 ONT | 1 active | No | Mandatory | Optional | Replace ONT scenario |
| FOF4.3 | Transfer Secondary | 1 ONT | 2 active | No | Optional | Optional | |
| FOF4.4 | Connect & Replace | 1 ONT | 1 active | No | Optional | Optional | |
| FOF5.1 | Change Offer | 1 ONT | 1 active | Yes | Optional | Optional | |
| FOF5.2 | Modify Attribute | 1 ONT | 1 active | Yes | Optional | Optional | Internal ONT relocation / premise networking |
| FOF6.1 | Disconnect Primary | 1 ONT | 1 active | Yes | Not Required | Not Offered | |
| FOF7.1 | Connect Primary | None | n/a | n/a | Mandatory | Optional | Business offer - Full install required (non-Fibre In A Day location) |
| FOF7.2 | Connect Primary | None | n/a | n/a | Mandatory | Optional | Business offer - Full install required (Fibre In A Day location) |