{"items":[{"type":"group","label":"ND1651","items":[{"type":"link","label":"CityFibre Provisioning API - NICC ALA","link":"/openapi","routeSlug":"/openapi"},{"type":"link","label":"Introduction","link":"/openapi/section/introduction","routeSlug":"/openapi/section/introduction"},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication"},{"type":"link","label":"Network and Firewall Configuration","link":"/openapi/section/network-and-firewall-configuration","routeSlug":"/openapi/section/network-and-firewall-configuration"},{"type":"group","label":"FTTP Process Overview","link":"/openapi/section/fttp-process-overview","routeSlug":"/openapi/section/fttp-process-overview","items":[{"type":"link","label":"Customer and site information required for a Business Property","link":"/openapi/section/fttp-process-overview/customer-and-site-information-required-for-a-business-property","routeSlug":"/openapi/section/fttp-process-overview/customer-and-site-information-required-for-a-business-property"},{"type":"link","label":"Project reference","link":"/openapi/section/fttp-process-overview/project-reference","routeSlug":"/openapi/section/fttp-process-overview/project-reference"},{"type":"link","label":"New Install","link":"/openapi/section/fttp-process-overview/new-install","routeSlug":"/openapi/section/fttp-process-overview/new-install"},{"type":"link","label":"Modify","link":"/openapi/section/fttp-process-overview/modify","routeSlug":"/openapi/section/fttp-process-overview/modify"},{"type":"link","label":"Cease","link":"/openapi/section/fttp-process-overview/cease","routeSlug":"/openapi/section/fttp-process-overview/cease"},{"type":"link","label":"FTTH Installation Process Diagrams","link":"/openapi/section/fttp-process-overview/ftth-installation-process-diagrams","routeSlug":"/openapi/section/fttp-process-overview/ftth-installation-process-diagrams"},{"type":"link","label":"Gaining Provider Led Switches (GPLS)","link":"/openapi/section/fttp-process-overview/gaining-provider-led-switches-(gpls)","routeSlug":"/openapi/section/fttp-process-overview/gaining-provider-led-switches-(gpls)"},{"type":"link","label":"Working Line Takeovers (WLTO)","link":"/openapi/section/fttp-process-overview/working-line-takeovers-(wlto)","routeSlug":"/openapi/section/fttp-process-overview/working-line-takeovers-(wlto)"},{"type":"link","label":"One Touch Switch","link":"/openapi/section/fttp-process-overview/one-touch-switch","routeSlug":"/openapi/section/fttp-process-overview/one-touch-switch"},{"type":"link","label":"Remote Activation","link":"/openapi/section/fttp-process-overview/remote-activation","routeSlug":"/openapi/section/fttp-process-overview/remote-activation"},{"type":"link","label":"ONT Swaps","link":"/openapi/section/fttp-process-overview/ont-swaps","routeSlug":"/openapi/section/fttp-process-overview/ont-swaps"},{"type":"link","label":"Auto Compensation","link":"/openapi/section/fttp-process-overview/auto-compensation","routeSlug":"/openapi/section/fttp-process-overview/auto-compensation"},{"type":"link","label":"Next Best Action","link":"/openapi/section/fttp-process-overview/next-best-action","routeSlug":"/openapi/section/fttp-process-overview/next-best-action"},{"type":"link","label":"Case Comments","link":"/openapi/section/fttp-process-overview/case-comments","routeSlug":"/openapi/section/fttp-process-overview/case-comments"},{"type":"link","label":"Complex Installations","link":"/openapi/section/fttp-process-overview/complex-installations","routeSlug":"/openapi/section/fttp-process-overview/complex-installations"}]},{"type":"group","label":"Ethernet Process Overview","link":"/openapi/section/ethernet-process-overview","routeSlug":"/openapi/section/ethernet-process-overview","items":[{"type":"link","label":"Ethernet Availability Check","link":"/openapi/section/ethernet-process-overview/ethernet-availability-check","routeSlug":"/openapi/section/ethernet-process-overview/ethernet-availability-check"}]},{"type":"group","label":"Customer API Connectivity","link":"/openapi/section/customer-api-connectivity","routeSlug":"/openapi/section/customer-api-connectivity","items":[{"type":"link","label":"API Environment Introduction","link":"/openapi/section/customer-api-connectivity/api-environment-introduction","routeSlug":"/openapi/section/customer-api-connectivity/api-environment-introduction"},{"type":"link","label":"API Setup Process","link":"/openapi/section/customer-api-connectivity/api-setup-process","routeSlug":"/openapi/section/customer-api-connectivity/api-setup-process"},{"type":"link","label":"Required Information","link":"/openapi/section/customer-api-connectivity/required-information","routeSlug":"/openapi/section/customer-api-connectivity/required-information"},{"type":"link","label":"Test Scenarios","link":"/openapi/section/customer-api-connectivity/test-scenarios","routeSlug":"/openapi/section/customer-api-connectivity/test-scenarios"}]},{"type":"group","label":"Reference","link":"/openapi/section/reference","routeSlug":"/openapi/section/reference","items":[{"type":"link","label":"RFS Statuses","link":"/openapi/section/reference/rfs-statuses","routeSlug":"/openapi/section/reference/rfs-statuses"},{"type":"link","label":"LOC Codes","link":"/openapi/section/reference/loc-codes","routeSlug":"/openapi/section/reference/loc-codes"},{"type":"link","label":"Products","link":"/openapi/section/reference/products","routeSlug":"/openapi/section/reference/products"},{"type":"link","label":"Line Profiles","link":"/openapi/section/reference/line-profiles","routeSlug":"/openapi/section/reference/line-profiles"},{"type":"link","label":"Installation Process","link":"/openapi/section/reference/installation-process","routeSlug":"/openapi/section/reference/installation-process"},{"type":"link","label":"Status and Error Codes","link":"/openapi/section/reference/status-and-error-codes","routeSlug":"/openapi/section/reference/status-and-error-codes"}]},{"type":"separator","label":"API"},{"type":"group","label":"Addresses","link":"/openapi/addresses","routeSlug":"/openapi/addresses","items":[{"label":"Query Address Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addresses/queryaddresssearch","routeSlug":"/openapi/addresses/queryaddresssearch","metadata":{"seo":{"title":"Query Address Search","description":"To check the availability of a given location, the buyer should send a request containing either a postcode or a UPRN."}},"httpPath":"/queryAddressSearch"}]},{"type":"group","label":"Appointments","link":"/openapi/appointments","routeSlug":"/openapi/appointments","items":[{"label":"Query Appointment Availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/queryappointmentavailability","routeSlug":"/openapi/appointments/queryappointmentavailability","metadata":{"seo":{"title":"Query Appointment Availability","description":"To check the availability for an appointment on a given location, timeframe, and product."}},"httpPath":"/queryAppointmentAvailability"},{"label":"Reserve Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/reserveappointment","routeSlug":"/openapi/appointments/reserveappointment","metadata":{"seo":{"title":"Reserve Appointment","description":"In order to reserve an appointment, the buyer should provide the UPRN, product and the appointment slot that they desire to the seller"}},"httpPath":"/reserveAppointment"}]},{"type":"group","label":"Orders","link":"/openapi/orders","routeSlug":"/openapi/orders","items":[{"label":"Create NewInstall Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/installorder","routeSlug":"/openapi/orders/installorder","metadata":{"seo":{"title":"Create NewInstall Order","description":"Place an order for a new service"}},"httpPath":"/order"},{"label":"Create Modify Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/modifyorder","routeSlug":"/openapi/orders/modifyorder","metadata":{"seo":{"title":"Create Modify Order","description":"Request a change to an active service"}},"httpPath":"/orderModify"},{"label":"Create Cease Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/ceaseorder","routeSlug":"/openapi/orders/ceaseorder","metadata":{"seo":{"title":"Create Cease Order","description":"Request that an active service is ceased"}},"httpPath":"/ceaseOrder"},{"label":"Amend an Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/amendorder","routeSlug":"/openapi/orders/amendorder","metadata":{"seo":{"title":"Amend an Order","description":"Request to amend an in flight order."}},"httpPath":"/amendOrder"},{"label":"Cancel an Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/cancelorder","routeSlug":"/openapi/orders/cancelorder","metadata":{"seo":{"title":"Cancel an Order","description":"Request to cancel an in flight order"}},"httpPath":"/cancelOrder"}]},{"type":"group","label":"Products","link":"/openapi/products","routeSlug":"/openapi/products","items":[{"label":"Query Products for Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/queryproductsforlocation","routeSlug":"/openapi/products/queryproductsforlocation","metadata":{"seo":{"title":"Query Products for Location","description":"Check the available products for a given location using the location's UPRN."}},"httpPath":"/queryProductsForLocation"}]},{"type":"group","label":"Installation Details","link":"/openapi/installation-details","routeSlug":"/openapi/installation-details","items":[{"label":"Query Installation Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/installation-details/queryinstallationdetails","routeSlug":"/openapi/installation-details/queryinstallationdetails","metadata":{"seo":{"title":"Query Installation Details","description":"Get the information about such fields as: productName, serviceIdentifier, nniIdentifier, nniSVlanId, nniCVlandId, cfh:lineProfile, etc."}},"httpPath":"/queryInstallationDetails"}]},{"type":"separator","label":"Webhooks"},{"type":"group","label":"Order Status","link":"/openapi/order-status","routeSlug":"/openapi/order-status","items":[{"label":"Notify Of Order Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/order-status/notifyoforderstatus","routeSlug":"/openapi/order-status/notifyoforderstatus","metadata":{"seo":{"title":"Notify Of Order Status","description":"Messages sent back to the ALA user to indicate progress of an order."}},"httpPath":"/notifyOfOrderStatus"}]},{"type":"group","label":"Unsolicited Cease","link":"/openapi/unsolicited-cease","routeSlug":"/openapi/unsolicited-cease","items":[{"label":"Unsolicited Cease","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/unsolicited-cease/unsolicitedcease","routeSlug":"/openapi/unsolicited-cease/unsolicitedcease","metadata":{"seo":{"title":"Unsolicited Cease","description":"Unsolicited Cease"}},"httpPath":"/unsolicitedCeaseRequest"}]}]}]}