Contains functionality related to event registration.
Register
Registers a team in an event division.
Endpoint
POST https://football.exposureevents.com/api/v1/register
Parameters
Name | Type | Default | Required | Description |
---|---|---|---|---|
eventid | integer | The event id the participant is registering for. | ||
divisionid | integer | The division id the participant is registering for. | ||
name | string (100) | The participants team name. | ||
year | integer | 2024 | The year the participant is participating in. Must be a valid year. | |
gender | enumeration | The gender of the team. | ||
notes | string | Additional information viewed only internally about the team. | ||
markaspaid | boolean | true | Marks the team as paid. | |
enablecreditcard | boolean | true | Creates a payment and charges a credit card. Payment provider must be setup first and assigned to the event. | |
enablepaymentconfirmation | boolean | true | Sends a email confirmation after a successful payment is made. | |
address | object | The address of the team. | ||
address.city | string (100) | |||
address.stateregion | string (100) | |||
address.postalcode | string (10) | |||
meta | array (20) | An array of name/value objects. | ||
meta.key | string (100) | The key. | ||
meta.value | string (100) | The value. | ||
coaches | array (20) | An array of coaches and contacts for the team. | ||
coaches.primarycontact | boolean | false | The primary contact for the team. One primary contact is required per team. | |
coaches.firstname | string (100) | |||
coaches.lastname | string (100) | |||
coaches.email | string (100) | Must be a valid email. | ||
coaches.type | enumeration | Other | The role of the coach or contact. | |
coaches.ncaacoachesapprovalnumber | string (100) | NCAA coaches approval number used for NCAA certified events. | ||
coaches.mobilephone | string (100) | |||
coaches.homephone | string (100) | |||
coaches.workphone | string (100) | |||
coaches.faxphone | string (100) | |||
coaches.address | object | The address of the coach. | ||
coaches.address.streetaddress | string (100) | |||
coaches.address.extendedaddress | string (100) | |||
coaches.address.city | string (100) | |||
coaches.address.stateregion | string (100) | |||
coaches.address.postalcode | string (10) | |||
coaches.meta | array (20) | An array of name/value objects. | ||
coaches.meta.key | string (100) | The key. | ||
coaches.meta.value | string (100) | The value. | ||
players | array (20) | An array of players for the team. | ||
players.firstname | string (100) | |||
players.lastname | string (100) | |||
players.birthdate | date | The birthdate of the player in the format mm/dd/yyyy. | ||
players.homephone | string (100) | |||
players.mobilephone | string (100) | |||
players.email | string (100) | Must be a valid email. | ||
players.address | object | The address of the player. | ||
players.address.streetaddress | string (100) | |||
players.address.extendedaddress | string (100) | |||
players.address.city | string (100) | |||
players.address.stateregion | string (100) | |||
players.address.postalcode | string (10) | |||
players.number | integer | The number used by the player on this team. | ||
players.position | string (100) | The position played by the player. | ||
players.school | string (100) | The school of the player. | ||
players.graduationyear | integer | The graduation year of the player. | ||
players.meta | array (20) | An array of name/value objects. | ||
players.meta.key | string (100) | The key. | ||
players.meta.value | string (100) | The value. | ||
payment | object | The payment. Can only be used for non-redirect payment providers | ||
payment.priceid | integer | The payment price id. Only required if amount isn't supplied. | ||
payment.amount | decimal | The payment amount. Only required if price id isn't supplied. | ||
payment.title | string (100) | The payment title. Only required if price id isn't supplied. | ||
payment.description | string | The payment description. Only required if price ID isn't supplied. | ||
payment.firstname | string (100) | The billing contact first name. | ||
payment.lastname | string (100) | The billing contact last name. | ||
payment.email | string (100) | The billing contact email. Must be a valid email. | ||
payment.phone | string (100) | The billing contact phone number. | ||
payment.creditcardtype | string (100) | The credit card type (Visa, Mastercard, Discover, American Express). Only required if enabled credit card is enabled. | ||
payment.creditcardnumber | string (100) | The credit card number. Only required if enabled credit card is enabled. | ||
payment.creditcardexpireyear | integer | The credit card two digit expiration year. Only required if enabled credit card is enabled. | ||
payment.creditcardexpiremonth | integer | The credit card two digit expiration month. Only required if enabled credit card is enabled. | ||
payment.creditcardcvv2 | string (100) | The credit card security code. Only required if enabled credit card is enabled. | ||
payment.address | object | The billing contact address. Only required if enabled credit card is enabled. | ||
payment.address.streetaddress | string (100) | Only required if enabled credit card is enabled. | ||
payment.address.extendedaddress | string (100) | Only required if enabled credit card is enabled. | ||
payment.address.city | string (100) | Only required if enabled credit card is enabled. | ||
payment.address.stateregion | string (100) | Only required if enabled credit card is enabled. | ||
payment.address.postalcode | string (10) | Only required if enabled credit card is enabled. |
{
"EventId": 0,
"DivisionId": 20,
"Name": "Exposure Football Events Team",
"Year": "2012",
"Gender": 1,
"Notes": "This team can't play Tuesday.",
"EnableCreditCard": true,
"MarkAsPaid": false,
"EnableReceipt": true,
"Address": {
"City": "Gilbert",
"StateRegion": "AZ",
"PostalCode": "55555"
},
"Meta": [
{
"Name": "T-Shirt Size",
"Value": "XL"
},
{
"Name": "Hotel",
"Value": "Motel 8"
}
],
"Payment": {
"PriceId": 20,
"Amount": 150.0,
"Redeemed": false,
"CreditCardType": "Visa",
"CreditCardNumber": "4444444444444444",
"CreditCardExpireYear": "14",
"CreditCardExpireMonth": "10",
"CreditCardCvv2": "438",
"FirstName": "Bob",
"LastName": "Smith",
"Organization": "Exposure Events",
"StreetAddress": "22 Exposure Lane",
"ExtendedAddress": "Suite 22",
"City": "Gilbert",
"StateRegion": "AZ",
"PostalCode": "55555",
"Email": "noreply@exposureevents.com",
"Phone": "555-555-5555",
"Title": "Tournament Fee",
"Description": "Team Exposure (adidas Super 64 - 17)"
},
"Players": [
{
"Id": 0,
"Number": "22",
"FirstName": "Bob",
"LastName": "Smith",
"Address": {
"StreetAddress": "3934 E Battala Avenue",
"ExtendedAddress": "Suite 144",
"City": "Gilbert",
"StateRegion": "Arizona",
"PostalCode": "85297"
},
"Birthdate": "11/23/1992",
"HomePhone": "555-555-5555",
"MobilePhone": "555-555-5555",
"Email": "noreply@exposureevents.com",
"Meta": [
{
"Name": "NCAA Approved",
"Value": "Yes"
}
],
"Active": false
}
],
"Coaches": [
{
"Type": 3,
"FirstName": "Bob",
"LastName": "Smith",
"Address": {
"StreetAddress": "3934 E Battala Avenue",
"ExtendedAddress": "Suite 144",
"City": "Gilbert",
"StateRegion": "Arizona",
"PostalCode": "85297"
},
"HomePhone": "555-555-5555",
"MobilePhone": "555-555-5555",
"WorkPhone": "555-555-5555",
"FaxPhone": "555-555-5555",
"Email": "noreply@exposureevents.com",
"Meta": [
{
"Name": "NCAA Approved",
"Value": "Yes"
}
],
"Notes": "This coach has already paid for the event.",
"PrimaryContact": true,
"NCAACoachesApprovalNumber": "55-5555555"
}
]
}
<Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Address>
<City>Gilbert</City>
<PostalCode>55555</PostalCode>
<StateRegion>AZ</StateRegion>
</Address>
<Coaches>
<Coach>
<Address>
<City>Gilbert</City>
<ExtendedAddress>Suite 144</ExtendedAddress>
<PostalCode>85297</PostalCode>
<StateRegion>Arizona</StateRegion>
<StreetAddress>3934 E Battala Avenue</StreetAddress>
</Address>
<Email>noreply@exposureevents.com</Email>
<FaxPhone>555-555-5555</FaxPhone>
<FirstName>Bob</FirstName>
<HomePhone>555-555-5555</HomePhone>
<LastName>Smith</LastName>
<Meta>
<Meta>
<Name>NCAA Approved</Name>
<Value>Yes</Value>
</Meta>
</Meta>
<MobileCarrier i:nil="true" />
<MobilePhone>555-555-5555</MobilePhone>
<NCAACoachesApprovalNumber>55-5555555</NCAACoachesApprovalNumber>
<Notes>This coach has already paid for the event.</Notes>
<PrimaryContact>true</PrimaryContact>
<Type>3</Type>
<WorkPhone>555-555-5555</WorkPhone>
</Coach>
</Coaches>
<Discount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tournaments.Models.Discounts" i:nil="true" />
<DivisionId>20</DivisionId>
<EnableCreditCard>true</EnableCreditCard>
<EnableReceipt>true</EnableReceipt>
<EventId>0</EventId>
<FacebookPage i:nil="true" />
<Gender>1</Gender>
<InstagramHandle i:nil="true" />
<MarkAsPaid>false</MarkAsPaid>
<Meta>
<Meta>
<Name>T-Shirt Size</Name>
<Value>XL</Value>
</Meta>
<Meta>
<Name>Hotel</Name>
<Value>Motel 8</Value>
</Meta>
</Meta>
<Name>Exposure Football Events Team</Name>
<Notes>This team can't play Tuesday.</Notes>
<Payment>
<Amount>150</Amount>
<City>Gilbert</City>
<Country i:nil="true" />
<CreditCardCvv2>438</CreditCardCvv2>
<CreditCardExpireMonth>10</CreditCardExpireMonth>
<CreditCardExpireYear>14</CreditCardExpireYear>
<CreditCardNumber>4444444444444444</CreditCardNumber>
<CreditCardType>Visa</CreditCardType>
<Description>Team Exposure (adidas Super 64 - 17)</Description>
<Email>noreply@exposureevents.com</Email>
<ExtendedAddress>Suite 22</ExtendedAddress>
<FirstName>Bob</FirstName>
<LastName>Smith</LastName>
<Organization>Exposure Events</Organization>
<Phone>555-555-5555</Phone>
<PostalCode>55555</PostalCode>
<PriceLineItems>
<PaymentLineItem>
<Amount>0</Amount>
<Description i:nil="true" />
<Discount>0</Discount>
<Group i:nil="true" />
<PriceType i:nil="true" />
<Quantity>1</Quantity>
<Subgroup i:nil="true" />
<SubgroupKey i:nil="true" />
<Title i:nil="true" />
</PaymentLineItem>
</PriceLineItems>
<Redeemed>false</Redeemed>
<StateRegion>AZ</StateRegion>
<StreetAddress>22 Exposure Lane</StreetAddress>
<Title>Tournament Fee</Title>
<DiscountCode i:nil="true" />
<g-recaptcha-response i:nil="true" />
<PriceId>20</PriceId>
</Payment>
<Players>
<Player>
<ACTScore i:nil="true" />
<Active>false</Active>
<Address>
<City>Gilbert</City>
<ExtendedAddress>Suite 144</ExtendedAddress>
<PostalCode>85297</PostalCode>
<StateRegion>Arizona</StateRegion>
<StreetAddress>3934 E Battala Avenue</StreetAddress>
</Address>
<Bats i:nil="true" />
<BirthYear i:nil="true" />
<Birthdate>11/23/1992</Birthdate>
<College i:nil="true" />
<Email>noreply@exposureevents.com</Email>
<FirstName>Bob</FirstName>
<GPA i:nil="true" />
<Grade i:nil="true" />
<GraduationYear i:nil="true" />
<Height i:nil="true" />
<HomePhone>555-555-5555</HomePhone>
<Id>0</Id>
<LastName>Smith</LastName>
<Major i:nil="true" />
<Meta>
<Meta>
<Name>NCAA Approved</Name>
<Value>Yes</Value>
</Meta>
</Meta>
<MobileCarrier i:nil="true" />
<MobilePhone>555-555-5555</MobilePhone>
<Number>22</Number>
<Position i:nil="true" />
<SATScore i:nil="true" />
<School i:nil="true" />
<Throws i:nil="true" />
<TravelTeam i:nil="true" />
<Weight i:nil="true" />
</Player>
</Players>
<TwitterHandle i:nil="true" />
<Year>2012</Year>
</Request>
{
"TeamId": 1024,
"Status": 1
}
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Status>1</Status>
<TeamId>1024</TeamId>
</Response>