c3nav
    Preparing search index...

    Class LocationsAPI

    Locations are Levels, Spaces, Areas, POIs and Location Groups (see /locations/types/). They have a shared ID pool.

    This API endpoint only accesses locations that have can_search or can_describe set to true.

    If you want to access all of them, use the API endpoints for the Location Types.

    Additionally, you can access Custom Locations (Coordinates) by using c:<level.short_label>:x:y as an id or slug.

    Hierarchy

    • APIBase
      • LocationsAPI
    Index

    Constructors

    Properties

    apiClient: APIClient
    options: ClientOptions

    Methods

    • Set a new API URL.

      Parameters

      • newURL: string

        The new API url

      Returns void