FOR ARCHIVAL PURPOSES ONLY

The information in this wiki hasn't been maintained for a good while. Some of the projects described have since been deprecated.

In particular, the "Ushahidi Platform v3.x" section contains information that is often misleading. Many details about this version of Platform have changed since.

This website is an extraction of the original Ushahidi wiki into a static form. Because of that, functions like logging in, commenting or searching will not work.

For more documentation, please refer to https://docs.ushahidi.com

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Field

Type

Read/Write

Required on Create

Description

id

String

R

    The unique identifier for the river.

    name

    String

    RW

    Y

    The river's name.

    description

    String

    RW

    N

    A user defined description of the river.

    category

    String

    RW

    N

    Comma delimited list of category names the river is in.

    account

    Account

    R

      Account the river belongs to.

      follower_count

      Int

      R

        Number of users following the river.

        is_collaborator

        Boolean

        R

          True when the authenticating user is a collaborator for the river.

          is_following

          Boolean

          R

            True when the authenticating user is following the river.

            public

            Boolean

            RW

            N

            True when the river is a publicly accessible.

            active

            Boolean

            R

              True when the river is a active and flowing i.e. receiving drops from its channels.

              drop_count

              Int

              R

                Number of drops in the river.

                drop_quota

                Int

                R

                  Maximum number of drops a river can hold.

                  full

                  Boolean

                  R

                    True when drop_count equals drop_quota and the river cannot take in any more drops.

                    date_added

                    String

                    R

                      RFC822 formated date time string of when the river was created. E.g. "Wed, 27 Aug 2008 13:08:45 +0000"

                      expiry_date

                      String

                      R

                        RFC822 formated date time string of when the river will expire. E.g. "Wed, 27 Aug 2008 13:08:45 +0000"

                        extension_count

                        Int

                        R

                          Number of times the expiry date has been changed for the river.

                          channels

                          Channels

                          RW

                            List of channels defined in the river.

                            ...