Manage Appointment 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 checking appointment availability, reserving and updating appointments and retrieving appointment details.
| ID | Test case | Expected result | Endpoints |
|---|---|---|---|
| FMA1 | Submit a GET site visit appointment availability for an order. | The API will return a 200 response code with the available appointments. | /siteVisitAppointmentAvailability |
| FMA2 | Submit a GET RFS appointment availability for an order. | The API will return a 200 response code with the available appointments. | /rfsAppointmentAvailability |
| FMA3 | Submit a PUT reserve site visit appointment for an order. | The API will return a 200 response code and reserve or update the requested appointment. | /siteVisitAppointment |
| FMA4 | Submit a PUT update RFS appointment for an order. | The API will return a 200 response code and reserve or update the requested appointment. | /rfsAppointment |
| FMA5 | Submit a GET site visit appointment details for an order. | The API will return a 200 response code and reserve or update the requested appointment. | /siteVisitAppointment |
| FMA6 | Submit a GET RFS appointment details for an order. | The API will return a 200 response code and reserve or update the requested appointment. | /rfsAppointment |
| FMA7 | Reschedule an order following inter-appointment validation. 1. Submit a GET site visit appointment availability with validateInterAppointmentLeadTime attribute value of False for scope site visit. 2. Submit a GET site visit appointment availability for install site visit. 3. Submit a PUT reserve site visit appointment to move the install appointment. 4. Submit a PUT reserve site visit appointment to move the scope appointment. | The API will return a 200 response code and retrieve available appointments and then reserve the requested appointments. | /siteVisitAppointmentAvailability/siteVisitAppointment |
| FMA8 | Schedule an order with Advanced Scheduling at a location. 1. Receive a POST /orderFeasibility response with attribute advancedScheduling value: available. 2. Submit a GET site visit appointment availability for order 3. Submit a PUT reserve site visit appointment for order. | The API will return a 200 response code and reserve the requested appointment. | /siteVisitAppointment |
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 | Order type | Scenario | Site visit appointments offered | RFS appointments offered |
|---|---|---|---|---|
| FMA1.1 | Connect Primary | Full install | Scope Install Install/CSE | n/a |
| FMA1.2 | Connect Primary | Greenfield, or Fibre in a Day location | Install Install/CSE | n/a |
| FMA1.3 | Change Offer | CSE site visit request | CSE | n/a |
| FMA1.4 | Change Offer | Replace ONT required | Replace ONT Replace ONT/CSE | n/a |
| FMA2.1 | Connect Primary | Intact only order | n/a | Connect |
| FMA2.2 | Disconnect Primary | Intact only order | n/a | Disconnect |
| FMA3.1 | Connect Primary | Full install | Scope Install Install/CSE | n/a |
| FMA3.2 | Change Offer | CSE site visit request, | CSE | n/a |
| FMA3.3 | Change Offer | Replace ONT required | Replace ONT Replace ONT/CSE | n/a |
| FMA4.1 | Connect Primary | Intact only order | n/a | Connect |
| FMA4.2 | Disconnect Primary | Intact only order | n/a | Disconnect |
| FMA5.1 | Connect Primary | Full install | Scope Install Install/CSE | n/a |
| FMA5.2 | Change Offer | CSE site visit request | CSE | n/a |
| FMA5.3 | Change Offer | Replace ONT required | Replace ONT Replace ONT/CSE | n/a |
| FMA6.1 | Connect Primary | Intact only order | n/a | Connect |
| FMA6.2 | Disconnect Primary | Intact only order | n/a | Disconnect |
| FMA7.1 | Connect Primary | Customer requested reschedule | Scope Install Install/CSE | n/a |
| FMA8.1 | Connect Primary | Hyperfibre upgrade | Replace ONT Replace ONT/CSE | n/a |
If you have any questions about your test data needs or need to request access, contact API Support for assistance.