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

Skip to end of metadata
Go to start of metadata

Drops are the basic unit of information in SwiftRiver.

Field Guide

Field

Type

Read/Write

Required on Create

Description

id

String

R

The unique identifier for the drop.

title

String

RW

N

The title of the item if available.

content

String

RW

Y

The content of the item.

channel

String

RW

Y

The channel the drop came from E.g. twitter, rss, sms.

source

#Source

RW

Y

The source of the drop.

date_published

String

RW

Y

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

user_score

Int

RW

N

Authenticating user's score for the drop. Either -1, 0 or 1.

read

Boolean

RW

N

True when the authenticating account has marked the drop as read.

image

String

RW

N

URL of the primary image for the drop.

original_url

String

RW

N

Original source URL for the drop.

original_place

#Place

RW

N

Geo associated with the drop at the source.

original_id

String

RW

Y

ID for this drop at the source.

comment_count

Int

R

Number of comments on the drop.

buckets

Buckets

RW

N

Buckets the authenticating user has placed the drop in.

tags

Tags

RW

N

List of entities in the drop.

links

Links

RW

-N

List of urls in the drop.

media

#Media

RW

N

List of images,video... in the drop.

places

Places

RW

N

List of geo features in the drop.

Source

Field

Type

Read/Write

Required on Create

Description

id

String

R

The unique identifier for the source.

name

String

RW

Y

The name of the source.

username

String

RW

-Y

screen name used by the source.

identity_avatar

String

RW

N

URL to the source's avatar.

Tag

Field

Type

Read/Write

Required on Create

Description

id

String

R

The unique identifier for the tag.

tag

String

RW

Y

The name of the tag.

type

String

RW

Y

The type of tag: organization, person, place...

Field

Type

Read/Write

Required on Create

Description

id

String

R

The unique identifier for the url.

url

String

RW

Y

The link's URL.

Media

Field

Type

Read/Write

Required on Create

Description

id

String

R

The unique identifier for the media.

url

String

RW

Y

The URL for the media.

type

String

RW

Y

The media type E.g. image, video

Place

Field

Type

Read/Write

Required on Create

Description

id

String

R

The unique identifier for the place.

type

String

RW

Y

The type of data encoded in the cordinates property: point or polygon

name

String

RW

Y

Place name. Could be a City, County, point of interest etc.

coordinates

Array of Array floats

RW

Y

For point, a single [longitude, latitude] pair.

For polygon, a list of [longitude, latitude] pairs for each vertex.

Comment

Field

Type

Read/Write

Required on Create

Description

id

String

R

The unique identifier for the comment.

account

Account

RW

Y

Account object for the author of the comment.

comment_text

String

RW

Y

The comment body.

deleted

Boolean

RW

N

True when the comment is deleted.

date_added

String

R

Date the comment was published.

  • No labels