Manage Order 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:
- 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 creating. amending, and cancelling orders, as well as various GET requests for an order.
| ID | Test case | Expected result | Endpoints |
|---|---|---|---|
| FMO1 | Submit a Connect Primary order at a location for install. | The API returns a 200 response and creates the order, which will be scheduled for the appointment requested. | /createOrder |
| FMO2 | Submit a Connect Primary order at an MDU/ROW location or where Fibre Availability Status is not Ready. | The API returns a 200 response and creates the order, which will be manually processed by Chorus. | /createOrder |
| FMO3 | Submit a Connect Primary order at a location where an intact ONT is available to connect immediately. | The API returns a 200 response and creates the order, which will be scheduled for the appointment requested. | /createOrder |
| FMO4 | Submit a Connect Additional ONT order at a location to install another ONT. | The API returns a 200 response and creates the order, which will be scheduled for the appointment requested. | /createOrder |
| FMO5 | Submit a Transfer or Connect and Replace order at a location to replace a service. | The API returns a 200 response and creates the order, which will be scheduled for the appointment requested. | /createOrder |
| FMO6 | Submit a Change Offer, Modify Attribute or Disconnect order at a location to modify or disconnect an active service. | The API returns a 200 response and creates the order, which will be scheduled for the appointment requested. | /createOrder |
| FMO7 | Submit an amend order request on an open order at a location to manage and update the order. | The API returns a 200 response and the order will be amended with the request type. | /amendOrder |
| FMO8 | Submit an cancellation request on an open order at a location to cancel it | The API returns a 200 response and cancels the order. | /cancelOrder |
| FMO9 | Submit various GET requests associated to an open order at a location. | The API returns a 200 response and the requested data. | /orders/{orderId}/notifications/orders/{orderId}/attachments/getOrderDetails |
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.
createOrder
| Test case | Order type | Market Segment | Site Visit | CSE (Public or Private) | Test case comment |
|---|---|---|---|---|---|
| FMO1.1 | Connect Primary | Residential | Mandatory | Optional | Full install required |
| FMO1.2 | Connect Primary | Business or Education | Mandatory | Optional | Full install required |
| FMO1.3 | Connect Primary | Any | Mandatory | Optional | Greenfield or Fibre In a Day location |
| FMO2.1 | Connect Primary | Any | Not returned | Not Offered | MDU/ROW consent, design and build required |
| FMO2.2 | Connect Primary | Any | Not returned | Not Offered | Manual feasibility required |
| FMO3.1 | Connect Primary | Residential | Optional | Optional | Intact ONT activation |
| FMO3.2 | Connect Primary | Business or Education | Optional | Optional | Intact ONT activation |
| FMO4.1 | Connect Additional ONT | Residential | Mandatory | Optional | |
| FMO4.2 | Connect Additional ONT | Business or Education | Mandatory | Optional | |
| FMO5.1 | Transfer Primary | Any | Optional | Optional | |
| FMO5.2 | Connect and Replace | Any | Optional | Optional | |
| FMO6.1 | Change Offer | Any | Mandatory | Optional | Replace ONT required |
| FMO6.2 | Modify Attribute | Any | Optional | Optional | |
| FMO6.3 | Disconnect Primary | Any | Not returned | Not Offered |
amendOrder
| Test case | Order type | amendOrderType | Test case comment |
|---|---|---|---|
| FMO7.1 | Connect Primary | answer | Provider to Advise Note: To request this scenario, contact API Support with the Order IDs you want the corresponding question raised to answer on. |
| FMO7.2 | Connect Primary | answer | Quote Note: To request this scenario, contact API Support with the Order IDs you want the corresponding question raised to answer on. |
| FMO7.3 | Connect Primary | answer | Intent to Cancel Note: To request this scenario, contact API Support with the Order IDs you want the corresponding question raised to answer on. |
| FMO7.4 | Connect Primary | answer | Intent to Disconnect Note: To request this scenario, contact API Support with the Order IDs you want the corresponding question raised to answer on. |
| FMO7.5 | Connect Primary | answer | Intent to Disconnect Secondary Note: To request this scenario, contact API Support with the Order IDs you want the corresponding question raised to answer on. |
| FMO7.6 | Any | escalate | |
| FMO7.7 | Any | characteristic | |
| FMO7.8 | Any | interaction | |
| FMO7.9 | Any | orderDetails |
cancelOrder, getOrderNotifications, getOrderDetails, getOrderAttachmentDetails
| Test case | Order type | Endpoint |
|---|---|---|
| FMO8.1 | Any | /orders/{orderId} |
| FMO9.1 | Any | /orders/{orderId}/notifications |
| FMO9.2 | Any | /{orderId}/attachments/{attachmentId} |