Place API

1.0.x
(0 reviews)

About the Place API

The Place API allows you to search for an address or location and retrieve a unique location identifier (Place ID).

You can also request site information to check which products and ONTs are at a location, and determine if there are any open fibre orders.

Fibre ordering and fulfilment

When you start the fibre ordering process, the Place ID provided by the Place API is used to retrieve location information to assist with fibre fulfilment. This information includes network availability, site details, and product information. The information retrieved using the Place API is also used for other fibre ordering tasks, such as determining order feasibility.

Learn more about Fibre APIs and fibre ordering

What you can do with this API

The Place API enables you to query:

  • addresses by structured address inputs to find a customer’s address or location
  • address or location by Place ID (also known as TLC, or Supplier Location ID)
  • address or location using alternative identifiers, which may be associated to an address or location.

Note: Key-based identifiers include: PLSAM ID, TUI ID, Product ID and ONT Serial Number.

The Place API also enables you to obtain:

  • structured address information to validate a customer’s address or location
  • Chorus relevant information about a location, including:
    • all Product IDs pertaining to an ONT
    • existing ONTs, including ONT identifiers
    • pending open orders against an ONT
    • Chorus specific network information, including MDU/ROW consent and build statuses, fibre availability and more.

Reviews