State
=====







RPCS
----

.. function:: FBICrimeData.stateArrestCount(state: USTerritory, category: ArrestCategory, startYear: BoundedInteger<1985, 2019>, endYear: BoundedInteger<1985, 2019>)

    Get the number of arrests(for a particular offense) for the state in a certain time period

    **Arguments:**

    - ``state: USTerritory`` (`USTerritory </docs/fundamentals/rpc-arg-types.html#USTerritory>`__) - location of the state the crime occurred
    - ``category: ArrestCategory`` (`ArrestCategory </docs/fundamentals/rpc-arg-types.html#ArrestCategory>`__) - a general value describing the type of crime or perpetrator
    - ``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 state arrest count


.. function:: FBICrimeData.stateOffenseCount(state: USTerritory, offense: OffenseData, category: OffenseDataOpt)

    Get the number of offenses for a specific region

    **Arguments:**

    - ``state: USTerritory`` (`USTerritory </docs/fundamentals/rpc-arg-types.html#USTerritory>`__) - location of the crime (abbreviated US state)
    - ``offense: OffenseData`` (`OffenseData </docs/fundamentals/rpc-arg-types.html#OffenseData>`__) - the type of offense committed
    - ``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 the state offense count


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

    Get the number of supplemental offenses for a state

    **Arguments:**

    - ``state: USTerritory`` (`USTerritory </docs/fundamentals/rpc-arg-types.html#USTerritory>`__) - location of the crime in a state
    - ``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 state supplemental count


.. function:: FBICrimeData.stateVictimCount(state: USTerritory, 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:**

    - ``state: USTerritory`` (`USTerritory </docs/fundamentals/rpc-arg-types.html#USTerritory>`__) - state the crime occurred
    - ``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 state victim count