Event Virtual Registrations

Last Updated: July 27, 2012

This document lays out the specification of interacting with the Hobnob system, allowing for performing of Event virtual donation. For reading/updating donations via the API, see Donations

Event Virtual Donation Properties

• donor (collection) *
  
  • firstName (string) *
  • lastName (string) *
  • phoneNumber (string) **
  • mobileNumber (string) **
  • emailAddress (string) *
  • residentStreet (string) *
  • residentSuite (string)
  • residentCity (string) *
  • residentState (string) *
  • residentZip (string) *
  • residentCountry (string) **
  • organizationName (string)
  • position (string)
• classification (int)
• dedication (string)
• dedicationText (int) *required dedication is specified
• restriction (int)
• attributedPartyType (int) *

  Attributed Party

  The Attributed Party type is the entity type who will be receiving the donation. The attributedPartyType property must be one of the following integer values:

  • 0 : Event
  • 1 : Account
  • 2 : Team
• attributedParty (int) *
• amount (float)
• message (string)
• contactOptionMailViaPost (int)
• contactOptionReceiveUpdates (int)
• contactOptionPubliclyDisplayAmount (int)
• contactOptionPubliclyDisplayName (int)
• billingSame (int) *

  Replicating Personal Address Into Billing Address

  There are several places within the Hobnob system in which you can choose to use your personal information as your billing information. If the "billingSame" property is set to 0, the billing property must be defined:

  • billing (collection) *
    
    • street (string) *
    • suite (string)
    • city (string) *
    • state (string) *
    • zip (string) *
• billing (collection) *
  
  • street (string) *
  • suite (string)
  • city (string) *
  • state (string) *
  • zip (string) *
• payment (collection)

  Payment

  Payment information must be provided as a collection. Please see below for more information.

  • type (Credit Card, eCheck, check, or cash)
  • cardType (Visa, Mastercard, Discover, or American Express) *required with Credit Card
  • cardNumber (string) *required with Credit Card
  • cardHolderName (string) *required with Credit Card
  • expirationMonth (int) *required with Credit Card
  • expirationYear (int) *required with Credit Card
  • routingNumber (int) *required with eCheck
  • accountNumber (int) *required with eCheck
  • checkNumber (int) *required with check
  • type (Credit Card, eCheck, check, or cash)
  • cardType (Visa, Mastercard, Discover, or American Express) *required with Credit Card
  • cardNumber (string) *required with Credit Card
  • cardHolderName (string) *required with Credit Card
  • expirationMonth (int) *required with Credit Card
  • expirationYear (int) *required with Credit Card
  • routingNumber (int) *required with eCheck
  • accountNumber (int) *required with eCheck
  • checkNumber (int) *required with check
• questions (collection)
  
  • id (int)
  • answer (string)

POST : admin/event/[id]/virtualdonation

Creates a Virtual Donation.

Input:

			
<donation>
	<donor>
		<firstName>Qgiv</firstName>
		<lastName>User</lastName>
		<street>50 Lake Morton Dr</street>
		<suite></suite>
		<city>Lakeland</city>
		<state>Florida</state>
		<zip>33811</zip>
		<email>qgiv.user@qgiv.com</email>
		<phone>8888888888</phone>
		<cell>888888888</cell>
	</donor>
	<billingSame>1</billingSame>
	<restriction>155</restriction>
	<classification>192</classification>
	<attributedPartyType>1</attributedPartyType>
	<attributedParty>2042</attributedParty>
	<amount>1.00</amount>
	<contactOptionMailViaPost>1</contactOptionMailViaPost>
	<contactOptionReceiveUpdates>1</contactOptionReceiveUpdates>
	<contactOptionPubliclyDisplayAmount>1</contactOptionPubliclyDisplayAmount>
	<contactOptionPubliclyDisplayName>1</contactOptionPubliclyDisplayName>
	<payment>
		<type>Credit Card</type>
		<cardType>Visa</cardType>
		<cardNumber>8888888888888888</cardNumber>
		<cardHolderName>Qgiv User</cardHolderName>
		<expirationMonth>01</expirationMonth>
		<expirationYear>2016</expirationYear>
	</payment>
	<questions>
		<question id="144">
			<answer>one</answer>
		</question>
	</questions>
</donation>
			
		

			
{
   "donation":{
      "donor":{
         "firstName":"Qgiv",
         "lastName":"User",
         "street":"50 Lake Morton Dr",
         "suite":"",
         "city":"Lakeland",
         "state":"Florida",
         "zip":"33811",
         "email":"qgiv.user@qgiv.com",
         "phone":"8888888888",
         "cell":"888888888"
      },
      "billingSame":"1",
      "restriction":"155",
      "classification":"192",
      "attributedPartyType":"1",
      "attributedParty":"2042",
      "amount":"1.00",
      "contactOptionMailViaPost":"1",
      "contactOptionReceiveUpdates":"1",
      "contactOptionPubliclyDisplayAmount":"1",
      "contactOptionPubliclyDisplayName":"1",
      "payment":{
         "type":"Credit Card",
         "cardType":"Visa",
         "cardNumber":"8888888888888888",
         "cardHolderName":"Qgiv User",
         "expirationMonth":"01",
         "expirationYear":"2016"
      },
      "questions":{
         "question":{
            "answer":"one",
            "id":"144"
         }
      }
   }
}
			
		

Output:

			
<donation id="1982">
	<donor id="4853">
		<firstName>Qgiv</firstName>
		<lastName>User</lastName>
		<position></position>
		<phoneNumber></phoneNumber>
		<mobileNumber></mobileNumber>
		<emailAddress>qgiv.user@qgiv.com</emailAddress>
		<residentStreet>50 Lake Morton Dr</residentStreet>
		<residentSuite></residentSuite>
		<residentCity>Lakeland</residentCity>
		<residentState>Florida</residentState>
		<residentZip>33811</residentZip>
		<residentCountry>US</residentCountry>
		<organizationName></organizationName>
	</donor>
	<restriction>155</restriction>
	<contactOptionReceiveUpdates>1</contactOptionReceiveUpdates>
	<contactOptionMailViaPost>1</contactOptionMailViaPost>
	<contactOptionPubliclyDisplayName>1</contactOptionPubliclyDisplayName>
	<contactOptionPubliclyDisplayAmount>1</contactOptionPubliclyDisplayAmount>
	<classification>192</classification>
	<receivingPartyType>1</receivingPartyType>
	<receivingParty>2042</receivingParty>
	<donationAmount>1.00</donationAmount>
	<paymentType>Credit Card</paymentType>
	<questions>
		<question id="144">
			<answer>one</answer>
		</question>
	</questions>
</donation>
			
		

			
{
   "donation":{
      "donor":{
         "firstName":"Qgiv",
         "lastName":"User",
         "position":"",
         "phoneNumber":"",
         "mobileNumber":"",
         "emailAddress":"qgiv.user@qgiv.com",
         "residentStreet":"50 Lake Morton Dr",
         "residentSuite":"",
         "residentCity":"Lakeland",
         "residentState":"Florida",
         "residentZip":"33811",
         "residentCountry":"US",
         "organizationName":"",
         "id":"4853"
      },
      "restriction":"155",
      "contactOptionReceiveUpdates":"1",
      "contactOptionMailViaPost":"1",
      "contactOptionPubliclyDisplayName":"1",
      "contactOptionPubliclyDisplayAmount":"1",
      "classification":"192",
      "receivingPartyType":"1",
      "receivingParty":"2042",
      "donationAmount":"1.00",
      "paymentType":"Credit Card",
      "questions":{
         "question":{
            "answer":"one",
            "id":"144"
         }
      },
      "id":"1982"
   }
}
			
		

* denotes a required field

** denotes a required field based on Event settings

*** denotes a field that is only required when submitting Form level API credentials