National
========







RPCS
----

.. function:: FBICrimeData.nationalArrestCount(offense: OffenseArrest, category: Enum<male, female, race>, startYear: BoundedInteger<1985, 2019>, endYear: BoundedInteger<1985, 2019>, ageCategory: ArrestAgeCategory?)

    Get the number of arrests for the nation in a certain time period

    **Arguments:**

    - ``offense: OffenseArrest`` (`OffenseArrest </docs/fundamentals/rpc-arg-types.html#OffenseArrest>`__) - the type of breach of a law or rule
    - ``category: Enum<male, female, race>`` (`Enum </docs/fundamentals/rpc-arg-types.html#Enum>`__) - variable that describes the individual or crime committed
    - ``startYear: BoundedInteger<1985, 2019>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - beginning year
    - ``endYear: BoundedInteger<1985, 2019>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - ending year
    - ``ageCategory: ArrestAgeCategory?`` (`ArrestAgeCategory </docs/fundamentals/rpc-arg-types.html#ArrestAgeCategory>`__) - the category of age statistics to retrieve - defaults to returning a table of all available age ranges

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - data related to national arrest count


.. function:: FBICrimeData.nationalOffenseCount(offense: OffenseData, category: OffenseDataOpt)

    Get the number of offenses for a specific instance

    **Arguments:**

    - ``offense: OffenseData`` (`OffenseData </docs/fundamentals/rpc-arg-types.html#OffenseData>`__) - the type of breach of a law or rule
    - ``category: OffenseDataOpt`` (`OffenseDataOpt </docs/fundamentals/rpc-arg-types.html#OffenseDataOpt>`__) - variable affecting crimes including examples: count, weapons, etc.

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - data related to national offense count


.. function:: FBICrimeData.nationalSupplementalCount(offense: OffenseSupplemental, category: SuppDataOpt, startYear: BoundedInteger<1985, 2019>, endYear: BoundedInteger<1985, 2019>)

    Get the number of supplemental offenses nationwise

    **Arguments:**

    - ``offense: OffenseSupplemental`` (`OffenseSupplemental </docs/fundamentals/rpc-arg-types.html#OffenseSupplemental>`__) - the type of breach of a law or rule
    - ``category: SuppDataOpt`` (`SuppDataOpt </docs/fundamentals/rpc-arg-types.html#SuppDataOpt>`__) - variable affecting crimes including examples: count, weapons, etc.
    - ``startYear: BoundedInteger<1985, 2019>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - beginning year
    - ``endYear: BoundedInteger<1985, 2019>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - ending year

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - data related to national supplemental count


.. function:: FBICrimeData.nationalVictimCount(offense: OffenseVictim, category: Enum<age, count, ethnicity, race, sex, relationship>)

    Get the number of victims for the nation based on the offense and variable

    **Arguments:**

    - ``offense: OffenseVictim`` (`OffenseVictim </docs/fundamentals/rpc-arg-types.html#OffenseVictim>`__) - the type of breach of a law or rule
    - ``category: Enum<age, count, ethnicity, race, sex, relationship>`` (`Enum </docs/fundamentals/rpc-arg-types.html#Enum>`__) - variable that describes the individual who committed the crime

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - data related to national victim count