API:people/signups

From wiki.groundcrew.us

Jump to: navigation, search

You're reading the API pages for Groundcrew

Returns per-person data for recent squad signups and invitations. This information can be used to determine if agents or organizers have not completed some part of the signup process, such as confirming a mobile number of providing a location. Beta.

Contents

[edit] URL

 http://wwww.groundcrew.us/api/squad/{squad_id}/signups.json

[edit] HTTP Method(s)

GET

[edit] Parameters

Required Name Type Description
required api_key string The authentication key associated with an organization.

[edit] Response

The result is a Javascript hash, which includes an array of signup hashes (about return values). Each signup hash may have some or all of the keys shown in the example below.

Example JSON response:

{
  "results": [
  {
    "id":            "073fd5924de0f4cf2955e1d38fbc2da6",
    "ts":            1259682862,
    "name":          "Noah",
    "city":          "Northampton, United States",
    "has_password":  true,
    "groups":        ["agent", "organizer"],
    "points":        [
                     { "sys":      "e",
                       "sysid":    "noah@citizenlogistics.com",
                       "stage":    "confirmed"
                     },
                     { "sys":      "m",
                       "sysid":    "+18001234567",
                       "stage":    "confirmed",
                       "msg":      "off",
                       "msg_ts":   1259684490,
                       "sent":     "ok, you are no longer listed as available",
                       "sent_ts":  1259684490
                     }]
  },                
  {                 
    "id":            "244996eb84e9c0882376630a1278572e",
    "ts":            1259961327,
    "name":          "Joe",
    "city":          null,
    "groups":        ["organizer"],
    "points":        [
                     { "sys":      "e",
                       "sysid":    "joe@citizenlogistics.com",
                       "stage":    "tentative"
                     }]
  }]
}

[edit] Example

curl http://wwww.groundcrew.us/api/squad/{squad_id}/people/signups.json?api_key={key}