API:return values

From wiki.groundcrew.us

Jump to: navigation, search

You're reading the API pages for Groundcrew

This is a list of data that may be returned by some of the Groundcrew API calls, with an explanation for each key. Most or all of the values can be null or blank.

bio
Description: a description related to an object, such as a person's favorite activities
Example: I like to eat oatmeal
cc2
Description: the 2-letter country code for the default country of an object
Example: US, ES
city
Description: the city and country name of a large city near an object's location
Example: Northampton, United States
email
Description: an email address for a person
Example: scout@citizenlogistics.com
email_confirmed
Description: whether an email address for a person was confirmed by that person
Example: true, false, null
email_sent
Description: a count of the number of emails sent by Groundcrew to a person. May represent fewer messages than have actually been sent.
Example: 0, 2
exid
Description: an external ID from a system that was used to import data into Groundcrew
Example: 123abc
exid_prefix
Description: the name of an external system that was used to import data into Groundcrew
Example: salsa
has_password
Description: whether a password has been set for a person
Example: true, false
id
Description: an internal ID for an object
Example: peddf60143395 (person)
lat
Description: the latitude of an object's location
Example: 42.3201796
lng
Description: the longitude of an object's location
Example: -72.6392791
loc
Description: the location of an object that was used to geocode it
Example: 1 main st., 01060
loc_ts
Description: the Unix timestamp that the location of an object was last updated
Example: 1258596496 (for Wed Nov 18 21:08:16 -0500 2009)
msg
Description: the most recent message received from a person
Example: okay
msg_ts
Description: the Unix timestamp that the last msg was received from a person
Example: 1258596496 (for Wed Nov 18 21:08:16 -0500 2009)
name
Description: the name of an object, e.g. a person
Example: Jillian, Dr. Rauf Tindle
phone
Description: a mobile phone number for a person
Example: +18001234567, +61234567890
phone_confirmed
Description: whether a phone number for a person was confirmed by that person
Example: true, false, null
points
Description: a collection of communication endpoints for a person or squad
Example: 
  [
    { "sys":      "e",
      "sysid":    "noah@citizenlogistics.com",
      "stage":    "confirmed"
    },
    { "sys":      "m",
      "sysid":    "+8001234567",
      "stage":    "confirmed"
    }
  ]
sent
Description: the most recent message sent to a person
Example: thanks
sent_ts
Description: the Unix timestamp that the last sent message was sent to a person
Example: 1258596496 (for Wed Nov 18 21:08:16 -0500 2009)
sms_received
Description: a count of the number of text messages received by Groundcrew from a person. May represent fewer messages than have actually been received.
Example: 0, 13
sms_sent
Description: a count of the number of text messages sent by Groundcrew to a person. May represent fewer messages than have actually been sent.
Example: 0, 73
stage
Description: the stage of a communication point
Example: confirmed, tentative
sys
Description: a letter indicating a communication system
Example: m (mobile), e (email), f (Facebook), t (Twitter), a (AIM)
sysid
Description: an address, such as an email address or phone number, for a person in a communication system
Example: +8001234567, noah@citizenlogistics.com
tags
Description: an array of tags on an object
Example: [], ['moonwatching', 'oatmeal']
thumb_url
Description: a small image of an object, e.g. a headshot
Example: http://groundcrew.us/images/70/5c/705c553abea6e6a4cc44d2e06004f067_thumb.jpg
ts
Description: the Unix timestamp that an object was last updated
Example: 1258596496 (for Wed Nov 18 21:08:16 -0500 2009)
url
Description: a homepage for an object
Example: http://citizenlogistics.com
Retrieved from "http://wiki.groundcrew.us/en/API:return_values"
Personal tools