Enums

DonationsGetQuery

ValueDescription
UserUidsFind donations according to their users. 

Editability

ValueDescription
AdministratorsAndUsersResponses to this question can be edited by both administrators and users.
AdministratorsOnlyResponses to this question can be edited by administrators only.

EventsGetQuery

ValueDescription
VersionFind events according to their versions.
TimeFind events according to their start times.

FormQuestionType

ValueDescription
AddressQuestion type representing an address.
BooleanQuestion type representing a boolean (true/false).
DateQuestion type representing a date.
EmailAddressQuestion type represeting an email address.
HeaderQuestion type that will display static header text on the form.
IntegerQuestion type represeting an integer.
ListQuestion type represeting a list of values.
NameQuestion type represeting a name.
PhoneNumberQuestion type represeting a phone number.
PhotosQuestion type representing a collection of photos.
SkillQuestion type represeting a user skill.
StringQuestion type representing a string (text).

FormQuestionToken

ValueDescription
EmailAllowedToken identifying the user's permission to receive email.
EmergencyContactNameToken identifing the name of the user's emergency contact.
EmergencyContactPhoneToken identifying the phone number of the user's emergency contact.
SmsAllowedToken identifying the user's permission to receive SMS messages.
UserAddressToken identifying the user's physical address.
UserBirthdayToken identifying the user's birthday.
UserEmailAddressToken identifying the user's email address.
UserFaxToken identifying the user's fax number.
UserGenderToken identifying the user's gender.
UserHomePhoneToken identifying the user's home phone number.
UserMobilePhoneToken identifying the user's mobile phone number.
UserNameToken identifying the user's name.
UserPagerToken identifying the user's pager number.
UserWorkPhoneToken identifying the user's work phone number.

UsersGetQuery

ValueDescription
LastUpdateFind users according to when they were last updated.

Visibility

ValueDescription
AdministratorsAndUsersQuestion is visible to both administrators and users.
AdministratorsOnlyQuestion is visible to administrators only.

Donation

class Donation
{
  Guid DonationUid
  Guid UserUid
  decimal Amount
  DateTime DateTime
}

Event

class Event
{
  DateTime EndTime
  Guid EventGroupUid
  Guid EventUid
  string Location
  string LongDescription
  string Name
  string ShortDescription
  DateTime StartTime
  UserGroupRegistration[] UserGroupRegistrations
  ulong Version
}

Properties

PropertyDescription
DateTime EndTimeThe ending time of the event.
Guid EventGroupUidThe unique id of the event group this event belongs to.
Guid EventUidThe unique id of the event.
string LocationThe location of the event.
string LongDescriptionThe long description of the event.
string NameThe name of the event.
string ShortDescriptionThe short description of the event.
DateTime StartTimeThe starting time of the event.
UserGroupRegistration[] UserGroupRegistrationsAn array of user group registrations for this event.
ulong VersionThe current version of this event object.

UserGroupRegistration

class UserGroupRegistration
{
  float? AnonymousHours
  int AnonymousSlotsUsed
  bool Deleted
  int SlotsReserved
  Guid UserGroupUid
  UserRegistration[] UserRegistrations
}

Properties

PropertyDescription
float? AnonymousHoursThe number of anonymous hours reported for this user group, or null if no hours have been reported.
int AnonymousSlotsUsedThe number of anonymous slots taken up by this group.
bool DeletedTrue if this user group reservation was deleted.
int SlotsReservedThe number of slots reserved for this group.
Guid UserGroupIdThe unique id of the registered user group.
UserRegistration[] UserRegistrationsAn array of user registrations.

UserRegistration

class UserRegistration
{
  int AnonymousSlotsUsed
  bool Deleted
  float? Hours
  DateTime RegistrationDate
  Guid UserUid
  int UserRegistrationId
  bool Waitlisted
}

Properties

PropertyDescription
int AnonymousSlotsUsedThe number of anonymous slots this user registration is consuming.
bool DeletedTrue if this user registration was deleted.
float? HoursThe number of hours reported for this user, or null if no hours have been reported.
DateTime RegistrationDateThe time and date when this user registration was created.
Guid UserIdThe unique id of the registered user.
int UserRegistrationIdThe id of this user registration.
bool WaitlistedTrue if the user registration is waitlisted for the event.

EventGroup

class EventGroup
{
  Guid EventGroupUid
  string Name
  Guid? ParentEventGroupUid
}

Properties

PropertyDescription
Guid EventGroupUidThe unique id of the event group.
string NameThe name of the event group.
Guid? ParentEventGroupUidThe unique id of the event group this event group belongs to, if any.

Organization

class Organization
{
  Guid ContactUserUid
  Form[] Forms
  string Name
  string Url
}

Properties

PropertyDescription
Guid ContactUserUidThe unique id of the user who is the contact for this organization.
Form[] FormsThe array of forms used by this organization.
string NameThe name of the organization.
string UrlThe url of the organization's marketing website.

Form

class Form
{
  FormQuestion[] FormQuestions
  string Name
}

Properties

PropertyDescription
FormQuestion[] FormQuestionsAn array of the questions making up this form.
string NameThe name of the form.

FormQuestion

class FormQuestion
{
  Editability Editability
  Guid FormQuestionUid
  FormQuestionType FormQuestionType
  string Name
  int Ordinal
  string Prompt
  bool Required
  string SubPrompt
  FormQuestionToken[] Tokens
  Visibility Visibility
}

Properties

PropertyDescription
Editability EditabilityThe editability of this question.
Guid FormQuestionUidThe unique id of this question.
FormQuestionType FormQuestionTypeThe type of this question.
string NameThe name of this question.
int OrdinalThe ordinal of this question, which determines its position on the form relative to other questions.
string PromptThe prompt for this question.
bool RequiredTrue if the a response is required for this question, false otherwise.
string SubPromptThe subprompt for this question.
FormQuestionToken[] TokensAn array of tokens that identify system-defined questions.
Visibility VisibilityThe visibility of this question.

User

class User
{

  DateTime Created

  FormAnswer[] FormAnswers
  Guid[] UserGroupMemberships
  int UserId
  string Username
  ulong Version
}

Properties

PropertyDescription
DateTime CreatedThe date and time this user was created.
FormAnswer[] FormAnswersAn array of answers that have been provided by this user.
Guid[] UserGroupMembershipsAn array of Guids identifying the user groups to which this user belongs.
int UserIdThe id of this user.
string UsernameThe username of this user.
ulong VersionThe current version of this user.

FormAnswer

class FormAnswer
{
  int FormAnswerId
  int FormQuestionId
}

Properties

PropertyDescription
int FormAnswerIdThe id of this form answer.
int FormQuestionIdThe id of the form question to which this answer belongs.

FormAnswerAddress

class FormAnswerAddress : FormAnswer
{
  string Address1
  string Address2
  string Address3
  string City
  string State
  string PostalCode
}

Properties

PropertyDescription
string Address1The first address line.
string Address2The second address line.
string Address3The third address line.
string CityThe city.
string StateThe state.
string PostalCodeThe postal code.

FormAnswerBoolean

class FormAnswerBoolean : FormAnswer
{
  bool Value
}

Properties

PropertyDescription
bool ValueA boolean (true/false) value of this answer.

FormAnswerDate

class FormAnswerDate : FormAnswer
{
  DateTime Value
}

Properties

PropertyDescription
DateTime ValueThe time and date value of this answer.

FormAnswerInteger

class FormAnswerInteger : FormAnswer
{
  int Value
}

Properties

PropertyDescription
int ValueThe integer value of this answer.

FormAnswerName

class FormAnswerName : FormAnswer
{
  string FirstName
  string MiddleName
  string LastName
}

Properties

PropertyDescription
string FirstNameThe first name of this answer.
string MiddleNameThe middle name of this answer.
string LastNameThe last name of this answer.

FormAnswerPhotos

class FormAnswerPhotos : FormAnswer
{
  PhotosAnswerPhoto[] Photos
}

Properties

PropertyDescription
PhotosAnswerPhoto[] PhotosAn array of photos attached to this answer.

FormAnswerString

class FormAnswerString : FormAnswer
{
  string Value
}

Properties

PropertyDescription
string ValueThe string value of this answer.

PhotosAnswerPhoto

class
{
  int PhotoId
  string Url
}

Properties

PropertyDescription
int PhotoIdThe id of this photo.
string UrlThe url from which this photo can be retrieved.

UserGroup

class UserGroup
{
  string Description
  string Name
  Guid? ParentUserGroupUid
  Guid UserGroupUid
}

Properties

PropertyDescription
string DescriptionThe description of this user group.
string NameThe name of this user group.
Guid? ParentUserGroupUidThe unique id of the user group this user group belongs to, if any.
Guid UserGroupUidThe unique id of this user group.