The following is an example of a Person’s (James W. Gordon) Signup for the Neighbors Calling Neighbors Event. James has been Invited to be the Host during Shift 2452 (specifically from 3PM to 4PM) at Campaign HQ.
{
"eventSignupId": 2452,
"person": {
"vanId": 100476252,
"firstName": "James",
"middleName": "Worthington",
"lastName": "Gordon"
},
"event": {
"eventId": 1370,
"name": "Neighbors Calling Neighbors",
"shortName": "NeighborCall"
},
"shift": {
"eventShiftId": 2162,
"name": null
},
"role": {
"roleId": 111687,
"name": "Host"
},
"status": {
"statusId": 4,
"name": "Invited"
},
"location": {
"locationId": 272,
"name": "Campaign HQ",
"displayName": "Campaign HQ, 48 Grove St Somerville, MA 02144-2500"
},
"startTimeOverride": "2015-06-01T15:00:00-04:00",
"endTimeOverride": "2015-06-01T16:00:00-04:00"
}
Signup
The overall Signup object has a number of properties with simple object values. Only simple objects’ unique identifiers are required.
Property | Type | Description |
---|---|---|
| int | Read-only; Unique identifier for this Signup |
| object | Required; An accessible Person |
| object | Required; A simple Event to sign up for |
| object | Required; A simple Shift of the Event |
| object | Required; A simple Role for this person to play |
| object | Required; A signup Status (e.g., “Invited”) |
| object | Required if |
| datetime | Optional; If specified, overrides the |
| datetime | Optional; If specified, overrides the |
| int | Optional; a Supporter Group to associate with this Event Signup |
Person
Property | Type | Description |
---|---|---|
| string | Required; Unique identifier for an accessible person |
| string | Read-only; A person’s first name, no longer than 20 characters |
| string | Read-only; A person’s middle name, no longer than 20 characters |
| string | Read-only; A person’s last name, no longer than 25 characters |
Event
Property | Type | Description |
---|---|---|
| int | Required; Unique identifier for an accessible Event |
| string | Read-only; A name for this Event, no longer than 500 characters |
| string | Read-only; A shorter name for this Event, no longer than 12 characters |
Shift
Property | Type | Description |
---|---|---|
| int | Required; Unique identifier for a Shift of this Event |
| string | Read-only; A name for this Shift, no longer than 15 characters |
Role
Property | Type | Description |
---|---|---|
| int | Required; Unique identifier for a Role available to this Event |
| string | Read-only; The name of this Role, no longer than 50 characters |
Status
Property | Type | Description |
---|---|---|
| int | Required; Unique identifier for a Status available to this Event (as specified by the Event Type) |
| string | Read-only; The name of this Status, no longer than 10 characters |
Location
Property | Type | Description |
---|---|---|
| int | Required; Unique identifier for an existing Location |
| string | Read-only; The name of this Location, no longer than 50 characters |
| string | Read-only; The name and address of this Location, no longer than 200 characters |