GlobalBiodiversity
==================



The GlobalBiodiversity service provides information on millions of species from around the globe.



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: GlobalBiodiversity.getChildren(id: BoundedInteger<0>, page: BoundedInteger<1>?)

    Get the taxonomical children of a node/entry in the tree of life.
    
    Because a node may have many children, only up to 20 children are returned per call to this RPC.
    You can check if there are more children by increasing the ``page`` number of children to return.
    When there are no more children, an empty list is returned.

    **Arguments:**

    - ``id: BoundedInteger<0>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - id of the taxonomy entry to get the children of
    - ``page: BoundedInteger<1>?`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - page number of results to return (default ``1``)

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - taxonomical children of the entry


.. function:: GlobalBiodiversity.getImage(url: String)

    Get an image from an image URL returned by :func:`GlobalBiodiversity.getImageURLs`.

    **Arguments:**

    - ``url: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - URL of the image to load

    **Returns:** ``Image`` (`Image </docs/fundamentals/rpc-arg-types.html#Image>`__) - the downloaded image


.. function:: GlobalBiodiversity.getMediaURLs(type: Enum<image, sound>?, id: BoundedInteger<0>, page: BoundedInteger<1>?)

    Get the URL of any media associated with a particular taxonomy node/entry in the tree of life.
    These URLs can then be passed to :func:`GlobalBiodiversity.getImage` or :func:`GlobalBiodiversity.getSound` to get the image/sound.
    
    Because there may be many associated media entries, only up to 20 entries are returned per call to this RPC (though each entry may have multiple URLs).
    You can check if there are more URLs by increasing the ``page`` number of results to return.
    When there are no more URLs, an empty list is returned.

    **Arguments:**

    - ``type: Enum<image, sound>?`` (`Enum </docs/fundamentals/rpc-arg-types.html#Enum>`__) - the type of media to return
    - ``id: BoundedInteger<0>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - id of the taxonomy node to get media from
    - ``page: BoundedInteger<1>?`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - page number of results to return (default ``1``)

    **Returns:** ``List<String>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `String </docs/fundamentals/rpc-arg-types.html#String>`__) - zero or more associated media URLs


.. function:: GlobalBiodiversity.getParent(id: BoundedInteger<0>)

    Get the taxonomical parent of a node/entry in the tree of life.

    **Arguments:**

    - ``id: BoundedInteger<0>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - id of the taxonomy entry to get the parent of

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - taxonomical parent of the entry


.. function:: GlobalBiodiversity.getSound(url: String)

    Get a sound from a sound URL returned by :func:`GlobalBiodiversity.getMediaURLs`.

    **Arguments:**

    - ``url: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - URL of the sound to load

    **Returns:** ``Audio`` (`Audio </docs/fundamentals/rpc-arg-types.html#Audio>`__) - the downloaded sound


.. function:: GlobalBiodiversity.searchSpecies(nameType: SpeciesNameType, name: BoundedString<3>, page: BoundedInteger<1>?)

    Search the database for species of the given common or scientific name.
    
    Because there may be many matches, only up to 20 search results are returned per call to this RPC.
    You can check if there are more matches by increasing the ``page`` number of results to return.
    When there are no more results, an empty list is returned.

    **Arguments:**

    - ``nameType: SpeciesNameType`` (`SpeciesNameType </docs/fundamentals/rpc-arg-types.html#SpeciesNameType>`__) - the type of name to search for
    - ``name: BoundedString<3>`` (`BoundedString </docs/fundamentals/rpc-arg-types.html#BoundedString>`__) - name of the species to search for
    - ``page: BoundedInteger<1>?`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - page number of results to return (default ``1``)

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__)