RegPoint Solutions - API Documentation


 API Access


Link structure

GET

https://regpointsecure.com
/api/<function>/<api_key>/{<row_id>}{?<filterkey>=<filtervalue>{&<filterkey>=<filtervalue>}}

POST

https://regpointsecure.com/api/<function>/


Getting Access To The API


An API Key must be present for all transactions to occur.  During GET requests, the API key is the third URL parameter.  During POST requests it must be present in either the request header 'apikey' or a POST variable 'apikey'.

APIKeys will be assigned by RegPoint at this time.  We will provide for a way to regenerate your apikey in our portal at a later date.

Protect your assigned key like you would any other password.  It allows access to all your data.

For testing purposes you can use

sandboxAPIKey

as your apikey


Getting A Specific Data Format

How to request a format

Send the header 'Accept' with the requested format (ex. 'Accept: application/xml' for xml)

PHP cURL example

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Accept: application/json'));

Formats available

Format

Accept Type

xml

application/xml

json

application/json

jsonp

application/javascript

serialized

application/vnd.php.serialized

php

text/plain

html

text/html

csv

application/csv

 

API Function Types


Batch Functions

Overview

These functions do some heavy lifting.  There are multiple inserts and queries in each; simpliying access to particular sets of data.

Functions

  • createRegistration
  • viewRegistrationInformation

Informational Functions

Overview

These functions serve up useful bits of information.

Functions

  • getNextOrderNumber
  • getRegOpenings

View Records

Overview

Most of the functions have one parameter, the main identifier of the information you are requesting.

The apikey must be sent as the third segment of the url

Each of the following functions allows for searching of information based on the query string in the uri.  For example:

 

http://regpointsecure.com/api/viewprograms/<apikey>/all?billing_code=1234

 

would return all records where the billing code is 1234.  You can specify as many filters as you wish. The API will attempt to match all filters so it is possible an error "no records found matching your filter criteria" will be returned.  You may filter by any of the available fields in each function.

If no identifier is specified, a data structure with parameter types is returned.

Functions

  • viewAddOns
  • viewAddOnsPurchased
  • viewAnswers
  • viewMasterAccountParticipants
  • viewMasterAccountPayments
  • viewMasterAccountRegistrations
  • viewMasterAccounts
  • viewParticipantRegistrations
  • viewParticipants
  • viewPayments
  • viewProgramAddOns
  • viewProgramAddOnsPurchased
  • viewProgramAnswers
  • viewProgramPayments
  • viewProgramPromoCodes
  • viewProgramQuestions
  • viewProgramRegistrations
  • viewPrograms
  • viewPromoCodes
  • viewQuestions
  • viewRegistrations

Add Records

Overview

These functions take no URL parameters.

Your apikey must be sent either through the http header 'apikey' or in POST variable 'apikey' along with all the other POST variables you are creating the record with.

Each function may have different required POST variables.  The main ID cannot be specified and will be assigned and returned automatically upon record creation.

Functions

  • addAddOn
  • addAddOnPurchase
  • addAnswer
  • addMaterAccount
  • addParticipant
  • addPayment
  • addProgram
  • addPromoCode
  • addQuestion
  • addRegistration

Possible Errors

Error Message

Cause

Resolution

<field> is not a part of this table

A field was POSTed that is not a part of the function

Remove the field from your POST values

You cannot specify a record ID when creating a record.

An ID field was POSTed to the function

Remove the ID field from the POST values.

Something Weird Happened...Record was created but unable to retrieve it.

This should not happen, if you get this message there may be a problem with your server.

Contact your system administrator

Unable to create record: <SQL Error>

There was an error inserting the record

The error message should give some insight

Edit Records

Overview

These functions take no URL parameters.

Your apikey must be sent either through the http header 'apikey' or in POST variable 'apikey' along with all the other POST variables you are updating the record with.

The only other required POST variable is the id of the record you wish to update.  You may exclude any fields you do not want to update.  Only fields which are included will be updated.

Functions

  • editAddOn
  • editAddOnPurchase
  • editAnswer
  • editMaterAccount
  • editParticipant
  • editPayment
  • editProgram
  • editPromoCode
  • editQuestion
  • editRegistration

Possible Errors

Error Message

Cause

Resolution

<field> is not a part of this table

A field was POSTed that is not a part of the function

Remove the field from your POST values

You must specify a record ID (<fieldname>) to update.

There was no ID field included in POST data

An ID field matching <fieldname> needs to be included in the POST data.

Unable to edit record: <SQL Error>

There was an error inserting the record

The error message should give some insight

Delete Records

Overview

These functions take no URL parameters.

Your apikey must be sent either through the http header 'apikey' or in POST variable 'apikey' along with the ID of the record you are deleting.

Functions

  • deleteAddOn
  • deleteAddOnPurchase
  • deleteAnswer
  • deleteMaterAccount
  • deleteParticipant
  • deletePayment
  • deleteProgram
  • deletePromoCode
  • deleteQuestion
  • deleteRegistration

 

Using the API Functions


Complete Function List

addAddOn

Description

Add a new add on

Usage

Request Method:

POST

URI:

/API/addAddOn/

POST fields:

NameDescriptionRequiredEventcode(string)Code identifying assigned program (deprecated please use assign_code instead) Add_on_desc(string)Short description / title that the user will see when deciding to purchase Add_on_price(decimal(10,2))Purchase price Add_on_detail(string)Details of the add on available for purchase Add_on_label(varchar)Identifying phrase of add on (shows on signup pages) Add_on_choices(string)Comma separated add on purchase options (e.g Large, Medium, Small) Images_name(string)  Internal_only(string)  Assign_code(string)Comma separated list of events that offer this Add On Reg_status(string)Whether or not the add on is available for purchase Success Data Structure<xml><status>1</status><add_on_id>94</add_on_id><data-submitted><eventcode>varchar</eventcode><add_on_desc>varchar</add_on_desc><add_on_price>decimal</add_on_price><add_on_detail>text</add_on_detail><add_on_label>varchar</add_on_label><add_on_choices>varchar</add_on_choices><image_name>varchar</image_name><internal_only>varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status></data-submitted><data-saved><add_on_id>94</add_on_id><eventcode>varchar</eventcode><add_on_desc>varchar</add_on_desc><add_on_price>0.00</add_on_price><add_on_detail>text</add_on_detail><add_on_label>varchar</add_on_label><add_on_choices>varchar</add_on_choices><image_name>varchar</image_name><internal_only> varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status></data-saved></xml>addAddOnPurchaseDescriptionCreate record of Add On PurchaseUsageRequest Method:POSTURI:/API/addAddOnPurchase/POST Fields:NameDescriptionRequiredEventcode(string)Code identifying program purchased for Add_on_desc(string)Short description / title of purchased add on Add_on_price(decimal(10,2))Price purchased at Add_on_choices(string)Selected Add on purchase option (e.g Medium) Add_on_label(string)Identifying phrase of add on (shows on signup pages) Order_number(decimal(10,2))Transaction Identifier the add on was purchased on Success Data Structure<xml><status>1</status><add_on_id>1273</add_on_id><data-submitted><eventcode>varchar</eventcode><add_on_desc>varchar</add_on_desc><add_on_price>decimal</add_on_price><add_on_choices>varchar</add_on_choices><add_on_label>varchar</add_on_label><order_number>varchar</order_number></data-submitted><data-saved><add_on_id>1273</add_on_id><eventcode>varchar</eventcode><add_on_desc>varchar</add_on_desc><add_on_price>0.00</add_on_price><add_on_choices>varchar</add_on_choices><add_on_label>varchar</add_on_label><order_number>varchar</order_number></data-saved></xml>addAnswerDescriptionCreate entry which answers a questionUsageRequest Method:POSTURI:/API/addAnswerPOST Fields:NameDescriptionRequiredquestion_id(int)Code identifying which question this is answering order_number(string)Identifies which registration the answer is tied to eventcode(string)Program code or Participant ID answer(string)Answer to question assign_type(string)'Participant' or NULL/empty string.  Set to 'Participant' if sending participant ID in eventcode field. Success Data Structure<xml><status>1</status><id>7027</id><data-submitted><question_id>int</question_id><order_number>varchar</order_number><eventcode>varchar</eventcode><answer>varchar</answer><assign_type>varchar</assign_type></data-submitted><data-saved><id>7027</id><question_id>0</question_id><order_number>varchar</order_number><eventcode>varchar</eventcode><answer>varchar</answer><assign_type>varchar</assign_type></data-saved></xml>addMasterAccountDescriptionCreate a master accountUsageRequest Method:POSTURI:/API/addMasterAccountPOST Fields:NameDescriptionRequiredaccountnumber(integer)New account number guard1_fname(string)Guardian's first name guard1_lname(string)Guardian's Last Name guard1_address(string)Guardian's Address guard1_city(string)City guard1_state(string)State guard1_zip(string)Zip Code guard1_country(string)Country guard1_phone(string)Phone number guard1_mobile(string)Cell Phone Number guard1_work(string)Work Phone number guard1_email(string)email address guard1_relation(string)Relationship to camper guard2_fname(string)Guardian's first name guard2_lname(string)Guardian's Last Name guard2_address(string)Guardian's Address guard2_city(string)City guard2_state(string)State guard2_zip(string)Zip Code guard2_country(string)Country guard2_phone(string)Phone number guard2_mobile(string)Cell Phone Number guard2_work(string)Work Phone number guard2_email(string)email address guard2_relation(string)Relationship to camper Userid(string)Master Account Login id Password(string)Master Account Password vault_pay_type(string)'Yes' or NULL/empty string date_added(timestamp)If left empty will be set with current date/time Success Data Structure<xml><status>1</status><id>939</id><data-submitted><accountnumber>int</accountnumber><guard1_fname>varchar</guard1_fname><guard1_lname>varchar</guard1_lname><guard1_address>varchar</guard1_address><guard1_city>varchar</guard1_city><guard1_state>varchar</guard1_state><guard1_zip>varchar</guard1_zip><guard1_country>varchar</guard1_country><guard1_phone>varchar</guard1_phone><guard1_mobile>varchar</guard1_mobile><guard1_work>varchar</guard1_work><guard1_email>varchar</guard1_email><guard1_relation>varchar</guard1_relation><guard2_fname>varchar</guard2_fname><guard2_lname>varchar</guard2_lname><guard2_address>varchar</guard2_address><guard2_city>varchar</guard2_city><guard2_state>varchar</guard2_state><guard2_zip>varchar</guard2_zip><guard2_country>varchar</guard2_country><guard2_phone>varchar</guard2_phone><guard2_mobile>varchar</guard2_mobile><guard2_work>varchar</guard2_work><guard2_email>varchar</guard2_email><guard2_relation>varchar</guard2_relation><userid>varchar</userid><vault_pay_type>varchar</vault_pay_type><date_added>timestamp</date_added></data-submitted><data-saved><id>939</id><accountnumber>0</accountnumber><guard1_fname>varchar</guard1_fname><guard1_lname>varchar</guard1_lname><guard1_address>varchar</guard1_address><guard1_city>varchar</guard1_city><guard1_state>varchar</guard1_state><guard1_zip>varchar</guard1_zip><guard1_country>varchar</guard1_country><guard1_phone>varchar</guard1_phone><guard1_mobile>varchar</guard1_mobile><guard1_work>varchar</guard1_work><guard1_email>varchar</guard1_email><guard1_relation>varchar</guard1_relation><guard2_fname>varchar</guard2_fname><guard2_lname>varchar</guard2_lname><guard2_address>varchar</guard2_address><guard2_city>varchar</guard2_city><guard2_state>varchar</guard2_state><guard2_zip>varchar</guard2_zip><guard2_country>varchar</guard2_country><guard2_phone>varchar</guard2_phone><guard2_mobile>varchar</guard2_mobile><guard2_work>varchar</guard2_work><guard2_email>varchar</guard2_email><guard2_relation>varchar</guard2_relation><userid>varchar</userid><password/><vault_pay_type>varchar</vault_pay_type><date_added>0000-00-00 00:00:00</date_added></data-saved></xml>addParticipantDescriptionCreate a participant in a master accountUsageRequest Method:POSTURI:/API/addParticipantPOST Fields:NameDescriptionRequiredmaster_id(integer)ID of master account Firstname(string)Participant First NameYesmiddlename(string)Participant Middle Name lastname(string)Participant Last NameYesDob(date)Participant Birth Date address(string)Participant Address city(string)Participant City state(string)Participant State zip(string)Participant Zip country(string)Participant Country Phone(string)Participant Phone Email(string)Participant EmailYESgender(string)Participant Gender relation_to_master(string)Relationship to master account Success Data Structure< xml><status>1</status><id>533</id><data-submitted><master_id>int</master_id><firstname>varchar</firstname><middlename>varchar</middlename><lastname>varchar</lastname><dob>date</dob><address>varchar</address><city>varchar</city><state>varchar</state><zip>varchar</zip><country>varchar</country><phone>varchar</phone><email>varchar</email><gender>varchar</gender><relation_to_master>varchar</relation_to_master></data-submitted><data-saved><id>533</id><master_id>0</master_id><firstname>varchar</firstname><middlename>varchar</middlename><lastname>varchar</lastname><dob>0000-00-00</dob><address>varchar</address><city>varchar</city><state>varchar</state><zip>varchar</zip><country>varchar</country><phone>varchar</phone><email>varchar</email><gender>varchar</gender><relation_to_master>varchar</relation_to_master></data-saved></xml>addPaymentDescriptionCreate a payment entryUsageRequest Method:POSTURI:/API/addPaymentPOST Fields:NameDescriptionRequiredtrans_date(timestamp)Will be automatically set Type(string)One of the following strings describing transaction type:'Cash', 'Check', 'Credit Card', 'E-Check', 'Discount/Adjustment', 'Refund', 'Deposit', 'Hold'YESAmount(decimal(10,2))Amount being collected Accountnumber(integer)Master Account ID Eventcode(string)ID of Event the amount is being collected for order_number(string)Registration this payment is for fname(string)First name of person making the payment (name on the credit card) lname(string)Last name of person making the payment (name on the credit card) comment(string)Comment on Transaction trans_id(string)Transaction ID from successful processing using payment gateway Success Data Structure<xml><status>1</status><id>681</id><data-submitted><trans_date>timestamp</trans_date><type>varchar</type><amount>decimal</amount><accountnumber>int</accountnumber><eventcode>varchar</eventcode><order_number>varchar</order_number><fname>varchar</fname><lname>varchar</lname><comment>varchar</comment><trans_id>varchar</trans_id></data-submitted><data-saved><id>681</id><trans_date>0000-00-00 00:00:00</trans_date><type>varchar</type><amount>0.00</amount><accountnumber>0</accountnumber><eventcode>varchar</eventcode><order_number>varchar</order_number><fname>varchar</fname><lname>varchar</lname><comment>varchar</comment><trans_id>varchar</trans_id></data-saved></xml>addProgramDescriptionUsageRequest Method:POSTURI:/API/addProgramPOST Fields:NameDescriptionRequiredeventcodeProgram Identifier billing_codeBilling code eventdescTitle of Program eventdesc_fullFull description sort_orderOrder of program in program list eventdesc_subSubtitle of Program reg_statusProgram status (Active, Inactive, Archived) dateDate the program starts date_endDate the program ends locationLocation of program reg_insurance_amountDeposit Amount deposit_last_pay_dateLast day to pay deposit staffbiosDescription of staff members onsite_contact_nameName of person who will be available at the program facility onsite_contact_emailemail of person who will be available at the program facility onsite_contact_phonePhone of person who will be available at the program facility facility_nameName of facility the program will be held at facility_addressAddress of facility the program will be held at facility_cityCity of facility the program will be held at facility_stateState of facility the program will be held at facility_zipZip of facility the program will be held at facility_urlWebsite of facility the program will be held at facility_map_urlIframe code to display map of facility location.  If left blank the map will be generated by Google Maps' API daily_scheduleDescription of schedule for event daily_schedule2Additional description of schedule for event daily_schedule3Additional description of schedule for event daily_schedule4Additional description of schedule for event daily_schedule5Additional description of schedule for event max_reg_campMaximum registrations the camp will accept max_waitlistAmount of registrations over the limit for a registration to be waitlisted max_reg_position1Maximum registrations the camp will accept for position1 max_reg_position2Maximum registrations the camp will accept for position2 max_reg_position3Maximum registrations the camp will accept for position3 max_reg_position4Maximum registrations the camp will accept for position4 max_reg_position5Maximum registrations the camp will accept for position5 max_reg_position6Maximum registrations the camp will accept for position6 max_reg_position7Maximum registrations the camp will accept for position7 max_reg_position8Maximum registrations the camp will accept for position8 max_reg_position9Maximum registrations the camp will accept for position9 max_reg_position10Maximum registrations the camp will accept for position10 position1Display title for camp position position2Display title for camp position position3Display title for camp position position4Display title for camp position position5Display title for camp position position6Display title for camp position position7Display title for camp position position8Display title for camp position position9Display title for camp position position10Display title for camp position position1_priceCost to register for position position2_priceCost to register for position position3_priceCost to register for position position4_priceCost to register for position position5_priceCost to register for position position6_priceCost to register for position position7_priceCost to register for position position8_priceCost to register for position position9_priceCost to register for position position10_priceCost to register for position convenience_feeAdditional fee to register group1  group2  group3  group4  group5  groups  auto_email  auto_email_type  precamp_email  POSTcamp_email  meta_info1  meta_info2  meta_info3  meta_info4  meta_info5  show_carrier'Y' or 'N' Flag to show  Carrier question show_policy_no'Y' or 'N' Flag to show  Policy Number question show_group_name'Y' or 'N' Flag to show  Group Name question show_group_no'Y' or 'N' Flag to show  Group Number question show_physician'Y' or 'N' Flag to show  physician question show_physician_phone'Y' or 'N' Flag to show  physician phone number question show_fullname'Y' or 'N' Flag to show question: Full name show_dob'Y' or 'N' Flag to show question: Birthday show_email'Y' or 'N' Flag to show question: email show_address'Y' or 'N' Flag to show question: Address show_city'Y' or 'N' Flag to show question: City show_state'Y' or 'N' Flag to show question: State show_POSTalcode'Y' or 'N' Flag to show question: Postal Code show_healthtitle'Y' or 'N' Flag to show question: Health Title show_insuredtitle'Y' or 'N' Flag to show question: Insured Title show_regdates'Y' or 'N' Flag to show question: Registration date range program_typeLegacy column no longer in use skip_health'Y' or 'N' Flag to skip all health related questions skip_addon'Y' or 'N' Flag to skip all addons skip_questions'Y' or 'N' Flag to skip all questions skip_econtact'Y' or 'N' Flag to skip sending all emails message_thankyoutext for thank you message message_registrationpolicytext for registration policy message_confirmtext for registration confirmation message_declinepayment declined message message_waitlistText to explain registration has been waitlisted how_did_you_hear_about_usOptions for drop down asking how the registrant heard of the camp.  Put advertising sources here. validate_questions'Yes' or 'No' string flag reg_cutoff_dateLast day to register min_gradeMinimum grade required to register for event.  NULL/empty string for no limit. max_gradeMaximum grade required to register for event.  NULL/empty string for no limit. min_ageMinimum registration age.  NULL/empty string for no limit. max_ageMaximum registration age.  NULL/empty string for no limit. gender_restrictGender to restrict registrations to. 'Male', 'Female', NULL/empty string strict_eligibilityFlag to enforce restrictions reg_policy_title_1Title of custom registration policy reg_policy_title_2Title of custom registration policy reg_policy_title_3Title of custom registration policy reg_policy_1custom registration policy text reg_policy_2custom registration policy text reg_policy_3custom registration policy text allow_groupsLegacy column not used max_groupsLegacy column not used max_reg_per_groupLegacy column not used group_liability_levelLegacy column not used group_invite_messageLegacy column not used Success Data Structure<xml><status>1</status><id>379</id><data-submitted><eventcode>varchar</eventcode><billing_code>varchar</billing_code><eventdesc>varchar</eventdesc><eventdesc_full>text</eventdesc_full><sort_order>int</sort_order><eventdesc_sub>varchar</eventdesc_sub><reg_status>varchar</reg_status><date>date</date><date_end>date</date_end><location>varchar</location><reg_insurance_amount>decimal</reg_insurance_amount><deposit_last_pay_date>date</deposit_last_pay_date><staffbios>text</staffbios><onsite_contact_name>varchar</onsite_contact_name><onsite_contact_email>varchar</onsite_contact_email><onsite_contact_phone>varchar</onsite_contact_phone><facility_name>varchar</facility_name><facility_address>varchar</facility_address><facility_city>varchar</facility_city><facility_state>varchar</facility_state><facility_zip>varchar</facility_zip><facility_url>varchar</facility_url><facility_map_url>text</facility_map_url><daily_schedule>text</daily_schedule><daily_schedule2>text</daily_schedule2><daily_schedule3>text</daily_schedule3><daily_schedule4>text</daily_schedule4><max_reg_camp>int</max_reg_camp><max_waitlist>int</max_waitlist><max_reg_position1>int</max_reg_position1><max_reg_position2>int</max_reg_position2><max_reg_position3>int</max_reg_position3><max_reg_position4>int</max_reg_position4><max_reg_position5>int</max_reg_position5><position1>varchar</position1><position2>varchar</position2><position3>varchar</position3><position4>varchar</position4><position5>varchar</position5><position1_price>decimal</position1_price><position2_price>decimal</position2_price><position3_price>decimal</position3_price><position4_price>decimal</position4_price><position5_price>varchar</position5_price><convenience_fee>decimal</convenience_fee><group1>varchar</group1><group2>varchar</group2><group3>varchar</group3><group4>varchar</group4><groups>varchar</groups><auto_email>int</auto_email><auto_email_type>int</auto_email_type><precamp_email>int</precamp_email><POSTcamp_email>int</POSTcamp_email><meta_info1>varchar</meta_info1><meta_info2>varchar</meta_info2><meta_info3>varchar</meta_info3><meta_info4>varchar</meta_info4><meta_info5>varchar</meta_info5><show_carrier>varchar</show_carrier><show_policy_no>varchar</show_policy_no><show_group_name>varchar</show_group_name><show_group_no>varchar</show_group_no><show_physician>varchar</show_physician><show_physician_phone>varchar</show_physician_phone><show_fullname>varchar</show_fullname><show_dob>varchar</show_dob><show_email>varchar</show_email><show_address>varchar</show_address><show_city>varchar</show_city><show_state>varchar</show_state><show_POSTalcode>varchar</show_POSTalcode><show_healthtitle>varchar</show_healthtitle><show_insuredtitle>varchar</show_insuredtitle><program_type>varchar</program_type><skip_health>varchar</skip_health><skip_addon>varchar</skip_addon><skip_questions>varchar</skip_questions><message_thankyou>text</message_thankyou><message_registrationpolicy>text</message_registrationpolicy><message_confirm>text</message_confirm><message_decline>text</message_decline><message_waitlist>text</message_waitlist><how_did_you_hear_about_us>varchar</how_did_you_hear_about_us><validate_questions>varchar</validate_questions><reg_cutoff_date>date</reg_cutoff_date><daily_schedule5>text</daily_schedule5><group5>varchar</group5><skip_econtact>varchar</skip_econtact><min_age>int</min_age><max_age>int</max_age><gender_restrict>varchar</gender_restrict><strict_eligibility>tinyint</strict_eligibility><reg_policy_title_1>varchar</reg_policy_title_1><reg_policy_title_2>varchar</reg_policy_title_2><reg_policy_title_3>varchar</reg_policy_title_3><reg_policy_1>text</reg_policy_1><reg_policy_2>text</reg_policy_2><reg_policy_3>text</reg_policy_3><allow_groups>varchar</allow_groups><max_groups>int</max_groups><max_reg_per_group>int</max_reg_per_group><group_liability_level>varchar</group_liability_level><group_invite_message>text</group_invite_message><max_reg_position6>int</max_reg_position6><max_reg_position7>int</max_reg_position7><max_reg_position8>int</max_reg_position8><max_reg_position9>int</max_reg_position9><max_reg_position10>int</max_reg_position10><position6>varchar</position6><position7>varchar</position7><position8>varchar</position8><position9>varchar</position9><position10>varchar</position10><position6_price>decimal</position6_price><position7_price>decimal</position7_price><position8_price>decimal</position8_price><position9_price>decimal</position9_price><position10_price>decimal</position10_price><show_regdates>varchar</show_regdates><min_grade>int</min_grade><max_grade>int</max_grade></data-submitted><data-saved><id>379</id><eventcode>varchar</eventcode><billing_code>varchar</billing_code><eventdesc>varchar</eventdesc><eventdesc_full>text</eventdesc_full><sort_order>0</sort_order><eventdesc_sub>varchar</eventdesc_sub><reg_status>varchar</reg_status><date>0000-00-00</date><date_end>0000-00-00</date_end><location>varchar</location><reg_insurance_amount>0.00</reg_insurance_amount><deposit_last_pay_date>0000-00-00</deposit_last_pay_date><staffbios>text</staffbios><onsite_contact_name>varchar</onsite_contact_name><onsite_contact_email>varchar</onsite_contact_email><onsite_contact_phone>varchar</onsite_contact_phone><facility_name>varchar</facility_name><facility_address>varchar</facility_address><facility_city>varchar</facility_city><facility_state>varchar</facility_state><facility_zip>varchar</facility_zip><facility_url>varchar</facility_url><facility_map_url>text</facility_map_url><daily_schedule>text</daily_schedule><daily_schedule2>text</daily_schedule2><daily_schedule3>text</daily_schedule3><daily_schedule4>text</daily_schedule4><max_reg_camp>0</max_reg_camp><max_waitlist>0</max_waitlist><max_reg_position1>0</max_reg_position1><max_reg_position2>0</max_reg_position2><max_reg_position3>0</max_reg_position3><max_reg_position4>0</max_reg_position4><max_reg_position5>0</max_reg_position5><position1>varchar</position1><position2>varchar</position2><position3>varchar</position3><position4>varchar</position4><position5>varchar</position5><position1_price>0.00</position1_price><position2_price>0.00</position2_price><position3_price>0.00</position3_price><position4_price>0.00</position4_price><position5_price>varchar</position5_price><convenience_fee>0.00</convenience_fee><group1>varchar</group1><group2>varchar</group2><group3>varchar</group3><group4>varchar</group4><groups>varchar</groups><auto_email>0</auto_email><auto_email_type>0</auto_email_type><precamp_email>0</precamp_email><POSTcamp_email>0</POSTcamp_email><meta_info1>varchar</meta_info1><meta_info2>varchar</meta_info2><meta_info3>varchar</meta_info3><meta_info4>varchar</meta_info4><meta_info5>varchar</meta_info5><show_carrier>varch</show_carrier><show_policy_no>varch</show_policy_no><show_group_name>varch</show_group_name><show_group_no>varch</show_group_no><show_physician>varch</show_physician><show_physician_phone>varch</show_physician_phone><show_fullname>varch</show_fullname><show_dob>varch</show_dob><show_email>varch</show_email><show_address>varch</show_address><show_city>varch</show_city><show_state>varch</show_state><show_POSTalcode>varch</show_POSTalcode><show_healthtitle>varch</show_healthtitle><show_insuredtitle>varch</show_insuredtitle><program_type>varch</program_type><skip_health>v</skip_health><skip_addon>v</skip_addon><skip_questions>v</skip_questions><message_thankyou>text</message_thankyou><message_registrationpolicy>text</message_registrationpolicy><message_confirm>text</message_confirm><message_decline>text</message_decline><message_waitlist>text</message_waitlist><how_did_you_hear_about_us>varchar</how_did_you_hear_about_us><validate_questions>varch</validate_questions><reg_cutoff_date>0000-00-00</reg_cutoff_date><daily_schedule5>text</daily_schedule5><group5>varchar</group5><skip_econtact>v</skip_econtact><min_age>0</min_age><max_age>0</max_age><gender_restrict>varchar</gender_restrict><strict_eligibility>0</strict_eligibility><reg_policy_title_1>varchar</reg_policy_title_1><reg_policy_title_2>varchar</reg_policy_title_2><reg_policy_title_3>varchar</reg_policy_title_3><reg_policy_1>text</reg_policy_1><reg_policy_2>text</reg_policy_2><reg_policy_3>text</reg_policy_3><allow_groups>v</allow_groups><max_groups>0</max_groups><max_reg_per_group>0</max_reg_per_group><group_liability_level>varchar</group_liability_level><group_invite_message>text</group_invite_message><max_reg_position6>0</max_reg_position6><max_reg_position7>0</max_reg_position7><max_reg_position8>0</max_reg_position8><max_reg_position9>0</max_reg_position9><max_reg_position10>0</max_reg_position10><position6>varchar</position6><position7>varchar</position7><position8>varchar</position8><position9>varchar</position9><position10>varchar</position10><position6_price>0.00</position6_price><position7_price>0.00</position7_price><position8_price>0.00</position8_price><position9_price>0.00</position9_price><position10_price>0.00</position10_price><show_regdates>varch</show_regdates><min_grade>0</min_grade><max_grade>0</max_grade></data-saved></xml>addPromoCodeDescriptionCreate a promo code to use during checkoutUsageRequest Method:POSTURI:/API/addPromoCodePOST Fields:NameDescriptionRequiredCode(string)The code a user will enter Amount(decimal(10,2))Flat amount Percentage(decimal(10,2))Percentage amount Type(string)Type of promotion.  Fixed or Percent valid_through(date)Promo code end date assign_code(string)Comma separated list of Programs this promo code is available to. Success Data Structure<xml><status>1</status><id>8</id><data-submitted><code>varchar</code><amount>decimal</amount><percentage>decimal</percentage><type>varchar</type><valid_through>date</valid_through><assign_code>text</assign_code></data-submitted><data-saved><id>8</id><code>varchar</code><amount>0.00</amount><percentage>0.00</percentage><type>varchar</type><valid_through>0000-00-00</valid_through><assign_code>text</assign_code></data-saved></xml>addQuestionDescriptionCreate a questionUsageRequest Method:POSTURI:/API/addQuestionPOST Fields:NameDescriptionRequiredeventcode(string)Code identifying assigned program (deprecated please use assign_code instead) question_type(string)Type of question (e.g. 'Text', 'Drop Down Listbox', 'Checkbox') question_choices(string)Comma seperated list of possible answers, use in case of question_type 'Drop Down Listbox' question_index(integer)Display position of question Question(string)Question the user will be answering require_validation(string)Whether the answer requires being validated against a rule set internal_only(string)  assign_code(string)Comma separated list of programs in which this question will be asked during registration reg_status(string)'Active' or 'Inactive'  Whether or not question is active assign_type(string)'Program' or 'Participant'     Success Data Structure<xml><status>1</status><id>288</id><data-submitted><eventcode>varchar</eventcode><question_type>varchar</question_type><question_choices>text</question_choices><question_index>int</question_index><question>text</question><require_validation>varchar</require_validation><internal_only>varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status><assign_type>varchar</assign_type></data-submitted><data-saved><id>288</id><eventcode>varchar</eventcode><question_type>varchar</question_type><question_choices>text</question_choices><question_index>0</question_index><question>text</question><require_validation>varch</require_validation><internal_only>varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status><assign_type>varchar</assign_type></data-saved></xml>addRegistrationDescriptionCreates a registration entryUsageRequest Method:POSTURI:/API/addRegistrationPOST Fields:NameDescriptionRequiredeventdescTitle of Program eventcodeID of Program registered for participant_fnameParticipant registered for event participant_lnameParticipant registered for event groupLegacy column, not used statusRegistration status:'Bill Me', 'Canceled', 'Confirmed', 'Declined', 'Deposit', 'New', 'Paid', 'Waitlist' order_numberRegistration order number billing_codeBilling code accountnumberMaster account id reg_dateDate the registration was processed participant_mnameParticipant registered for event participant_phoneParticipant registered for event email_primaryEmail to send communications to dobParticipant registered for event genderParticipant registered for event positionEvent position registered for priceTotal price ot registration addressParticipant registered for event cityParticipant registered for event stateParticipant registered for event POSTal_codeParticipant registered for event  countryParticipant registered for event promotional_codeCode entered at tiem of registration promotional_discountDiscount provided at time of registration emergency_contactEmergency contact name emergency_contact_phoneEmergency contact phone emergency_contact_relationRelation of emergency contact to participant how_did_you_hear_about_usHow participant heard of the program how_did_you_hear_otherCustom field for how use heard of program if other is selected health_insur_carrierParticipant Health Insurance Information health_policyParticipant Health Insurance Information health_group_nameParticipant Health Insurance Information health_groupParticipant Health Insurance Information health_dr_nameParticipant Health Insurance Information health_dr_phoneParticipant Health Insurance Information health_insured_nameParticipant Health Insurance Information health_insured_dobParticipant Health Insurance Information health_insured_emailParticipant Health Insurance Information health_insured_addressParticipant Health Insurance Information health_insured_cityParticipant Health Insurance Information health_insured_stateParticipant Health Insurance Information health_insured_zipParticipant Health Insurance Information activity_logHTML formated log of events on registration bill_me_flag'yes' or 'no' Billing Flag Bill Me deposit_flag'yes', 'no', 'paid' Billing Flag Deposit needed deposit_paidBilling Flag Deposit paid deposit_amntDeposit amount confirmation_sentFlag Email confirmation sent to email_primary confirmation_dateDate confirmation was sent form1_recvd'Y' or 'N' Flag Form 1 Recieved form2_recvd'Y' or 'N' Flag Form 1 Recieved form3_recvd'Y' or 'N' Flag Form 1 Recieved form4_recvd'Y' or 'N' Flag Form 1 Recieved form5_recvd'Y' or 'N' Flag Form 1 Recieved posting_flag'No' or 'Posted' pay_plan'Y' or 'N' group_idLegacy column not in use part_idParticipant ID session_dateAdvanced calendar feature that is not in use Success Data Structure<xml><status>1</status><id>1476</id><data-submitted><eventdesc>varchar</eventdesc><eventcode>varchar</eventcode><participant_fname>varchar</participant_fname><participant_lname>varchar</participant_lname><group>varchar</group><status>varchar</status><order_number>varchar</order_number><billing_code>varchar</billing_code><accountnumber>int</accountnumber><reg_date>timestamp</reg_date><participant_mname>varchar</participant_mname><participant_phone>varchar</participant_phone><email_primary>varchar</email_primary><dob>varchar</dob><gender>varchar</gender><position>varchar</position><price>decimal</price><address>varchar</address><city>varchar</city><state>varchar</state><POSTal_code>varchar</POSTal_code><country>varchar</country>                              <promotional_code>varchar</promotional_code><promotional_discount>decimal</promotional_discount><emergency_contact>varchar</emergency_contact><emergency_contact_phone>varchar</emergency_contact_phone><emergency_contact_relation>varchar</emergency_contact_relation><how_did_you_hear_about_us>varchar</how_did_you_hear_about_us><health_insur_carrier>varchar</health_insur_carrier><health_policy>varchar</health_policy><health_group_name>varchar</health_group_name><health_group>varchar</health_group><health_dr_name>varchar</health_dr_name><health_dr_phone>varchar</health_dr_phone><health_insured_name>varchar</health_insured_name><health_insured_dob>varchar</health_insured_dob><health_insured_email>varchar</health_insured_email><health_insured_address>varchar</health_insured_address><health_insured_city>varchar</health_insured_city><health_insured_state>varchar</health_insured_state><health_insured_zip>varchar</health_insured_zip><activity_log>text</activity_log><deposit_paid>varchar</deposit_paid><deposit_flag>varchar</deposit_flag><deposit_amnt>decimal</deposit_amnt><confirmation_sent>int</confirmation_sent><confirmation_date>timestamp</confirmation_date><bill_me_flag>varchar</bill_me_flag><form1_recvd>varchar</form1_recvd><form2_recvd>varchar</form2_recvd><form3_recvd>varchar</form3_recvd><form4_recvd>varchar</form4_recvd><form5_recvd>varchar</form5_recvd><POSTing_flag>varchar</POSTing_flag><pay_plan>varchar</pay_plan><how_did_you_hear_other>varchar</how_did_you_hear_other><group_id>int</group_id><part_id>int</part_id><session_date>datetime</session_date></data-submitted><data-saved><id>1476</id><eventdesc>varchar</eventdesc><eventcode>varchar</eventcode><participant_fname>varchar</participant_fname><participant_lname>varchar</participant_lname><group>varchar</group><status>varchar</status><order_number>varchar</order_number><billing_code>varchar</billing_code><accountnumber>0</accountnumber><reg_date>0000-00-00 00:00:00</reg_date><participant_mname>varchar</participant_mname><participant_phone>varchar</participant_phone><email_primary>varchar</email_primary><dob>varchar</dob><gender>varchar</gender><position>varchar</position><price>0.00</price><address>varchar</address><city>varchar</city><state>varchar</state><POSTal_code>varchar</POSTal_code><country>varchar</country><promotional_code>varchar</promotional_code><promotional_discount>0.00</promotional_discount><emergency_contact>varchar</emergency_contact><emergency_contact_phone>varchar</emergency_contact_phone><emergency_contact_relation>varchar</emergency_contact_relation><how_did_you_hear_about_us>varchar</how_did_you_hear_about_us><health_insur_carrier>varchar</health_insur_carrier><health_policy>varchar</health_policy><health_group_name>varchar</health_group_name><health_group>varchar</health_group><health_dr_name>varchar</health_dr_name><health_dr_phone>varchar</health_dr_phone><health_insured_name>varchar</health_insured_name><health_insured_dob>varchar</health_insured_dob><health_insured_email>varchar</health_insured_email><health_insured_address>varchar</health_insured_address><health_insured_city>varchar</health_insured_city><health_insured_state>varchar</health_insured_state><health_insured_zip>varchar</health_insured_zip><activity_log>text</activity_log><deposit_paid>varchar</deposit_paid><deposit_flag>varchar</deposit_flag><deposit_amnt>0.00</deposit_amnt><confirmation_sent>0</confirmation_sent><confirmation_date>0000-00-00 00:00:00</confirmation_date><bill_me_flag>varch</bill_me_flag><form1_recvd>varch</form1_recvd><form2_recvd>varch</form2_recvd><form3_recvd>varch</form3_recvd><form4_recvd>varch</form4_recvd><form5_recvd>varch</form5_recvd><POSTing_flag>varchar</POSTing_flag><pay_plan>varchar</pay_plan><how_did_you_hear_other>varchar</how_did_you_hear_other><group_id>0</group_id><part_id>0</part_id><session_date>0000-00-00 00:00:00</session_date></data-saved></xml>createRegistrationDescriptionCreates a new registration / order with all associated records from basic information provide by post variables.  User is required to provide master account number, participant id, program event code, program position, payment amount,UsageRequest MethodPOSTURI:/API/createRegistrationRequired Post FieldsNameDescriptionmaster_account[accountnumber](string)Number of account that will be paying for registrationparticipant[id](string)Participant who will be attending the program must be assigned to master accountprogram[eventcode](string)The event code for the program customer is registering forprogram[position](string)Which position customer is registering for ('position1', 'postion2', ... 'position10')payment[amount](decimal(10,2))The total amount to be charged to customerpayment[type](string)'cash, 'check', 'E-Check', 'Credit Card'If the payment type is E-Check these additional fields are required:'checkname' - Name on customer's ACH account'checkaba' - Customer's bank routing number'checkaccount' - Customer's bank account number'account_holder_type' - 'business' / 'personal''account_type' - 'checking' / 'savings'If the payment type is 'Credit Card' these additional fields are required:'ccnumber' - Credit card number'ccexp' - Credit Card Expiration datepayment[status](string)'Deposit', 'Paid'Signifies what the final status will beOptional Post Fieldsanswers[index][question_id]answers[index][answer] (string)Array of registration questions answered during signup add_ons[index][add_on_id]add_ons[index][add_on_choices] (string)Array of add ons purchased as part of this transaction registration[field](string)Additional registration fields.See addRegistration for available fields            Success Data Structure<xml><master_account><status>1</status><message>Selected master account.</message><id>938</id><post_data><accountnumber>88116939</accountnumber></post_data></master_account><participant><status>1</status><message>Selected participant.</message><id>532</id><post_data><id>532</id></post_data></participant><program><status>1</status><message>Selected program.</message><id>275</id><post_data><eventcode>CR7665</eventcode><position>1</position></post_data></program><promo_code><id>1</id><code>test</code><amount>10.00</amount><percentage>0.00</percentage><type>Static Amount</type><valid_through>2013-07-25</valid_through><assign_code>'CR7665'</assign_code></promo_code><transaction><response>1</response><responsetext>SUCCESS</responsetext><authcode>123456</authcode><transactionid>1821732035</transactionid><avsresponse/><cvvresponse/><orderid>CR-REG0898896</orderid><type>sale</type><response_code>100</response_code><merchant_defined_field_6/><merchant_defined_field_7/><customer_vault_id/></transaction><registration><order_number>CR-REG0898896</order_number></registration><reg_results><status>1</status><id>1480</id><data-submitted><order_number>CR-REG0898896</order_number><group_id>0</group_id><reg_date>2013-02-25 15:30:44</reg_date><accountnumber>88116939</accountnumber><part_id>532</part_id><participant_fname>John Jr</participant_fname><participant_mname>Jr</participant_mname><participant_lname>Smith</participant_lname><participant_phone>4045125434</participant_phone><email_primary/><address>123 Main St</address><city>Anywhere</city><state>GA</state><postal_code>30189</postal_code><country>US</country><dob>2010-02-02</dob><gender>Male</gender><session_date>2012-07-21</session_date><eventdesc>Goal Keepers Camp </eventdesc><deposit_amnt>250.00</deposit_amnt><position>Day Camper</position><price>395.00</price><promotional_code>test</promotional_code></data-submitted><data-saved><id>1480</id><eventdesc>Goal Keepers Camp </eventdesc><eventcode/><participant_fname>John Jr</participant_fname><participant_lname>Smith</participant_lname><group/><status>Incomplete</status><order_number>CR-REG0898896</order_number><billing_code/><accountnumber>88116939</accountnumber><reg_date>2013-02-25 15:30:44</reg_date><participant_mname>Jr</participant_mname><participant_phone>4045125434</participant_phone><email_primary/><dob>2010-02-02</dob><gender>Male</gender><position>Day Camper</position><price>395.00</price><address>123 Main St</address><city>Anywhere</city><state>GA</state><postal_code>30189</postal_code><country>US</country><promotional_code>test</promotional_code><promotional_discount>0.00</promotional_discount><emergency_contact/><emergency_contact_phone/><emergency_contact_relation/><how_did_you_hear_about_us/><health_insur_carrier/><health_policy/><health_group_name/><health_group/><health_dr_name/><health_dr_phone/><health_insured_name/><health_insured_dob/><health_insured_email/><health_insured_address/><health_insured_city/><health_insured_state/><health_insured_zip/><activity_log/><deposit_paid>no</deposit_paid><deposit_flag>no</deposit_flag><deposit_amnt>250.00</deposit_amnt><confirmation_sent>0</confirmation_sent><confirmation_date>0000-00-00 00:00:00</confirmation_date><bill_me_flag>no</bill_me_flag><form1_recvd>N</form1_recvd><form2_recvd>N</form2_recvd><form3_recvd>N</form3_recvd><form4_recvd>N</form4_recvd><form5_recvd>N</form5_recvd><posting_flag/><pay_plan>N</pay_plan><how_did_you_hear_other/><group_id>0</group_id><part_id>532</part_id><session_date>2012-07-21 00:00:00</session_date></data-saved></reg_results><trans_results><status>1</status><id>688</id><data-submitted><trans_date>20130225153041</trans_date><type>Credit Card</type><amount>1.25</amount><accountnumber>88116939</accountnumber><eventcode>CR7665</eventcode><order_number>CR-REG0898896</order_number><fname>John</fname><lname>Smith</lname><trans_id>1821732035</trans_id></data-submitted><data-saved><id>688</id><trans_date>2013-02-25 15:30:41</trans_date><type>Credit Card</type><amount>1.25</amount><accountnumber>88116939</accountnumber><eventcode>CR7665</eventcode><order_number>CR-REG0898896</order_number><fname>John</fname><lname>Smith</lname><comment/><trans_id>1821732035</trans_id></data-saved></trans_results></xml> Possible ErrorsError MessageCauseResolution       Setting Registration statusPass in registration[status] with desired status text from table or follow one of the other ways as noted belowDesired StatusWays to get this statusBill MeIf allow bill me option is set and no payment[amount] is passedCanceled ConfirmedIf auto confirm is enabled and no other status is passed through and no other action overwrites the status (such as declined, paid, waitlist)DeclinedIf the transaction type is 'Credit Card' or 'E-Check' and the processing result is declinedDepositIf payment[status] is set to 'Partial'Newthis is the default status it can be overwritten by other actionsif both auto confirm and auto process are offPaidIf payment[amount] = 0 and the price of the program position is 0if payment[status] is set to 'Full'WaitlistIf there are no available registrations in the requested program position and waitlist not full editAddOnDescriptionUpdates an Add On with POST variablesUsageRequest Method:POSTURI:/api/editAddOn/            Updates an Add On by add_on_id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><add_on_id>31</add_on_id><eventcode>CR2198</eventcode><add_on_desc>Before Care / After Care</add_on_desc><add_on_price>30.00</add_on_price><add_on_detail>Before Care - drop your camper off as early as 6amAfter Care - pickup your camper as late as 6pm </add_on_detail><add_on_label/><add_on_choices>Before, After </add_on_choices><image_name/><internal_only>N</internal_only><assign_code>'CR8745'</assign_code><reg_status>Active</reg_status></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (add_on_id) to updateThere was no add_on_id specified in POST variablesResubmit request with add_on_id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editAddOnPurchasedDescriptionEdit Add On Purchased detailsUsageRequest MethodPOSTURIs/api/editAddOnPurchased            Updates a Purchased Add On by add_on_id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><add_on_id>276</add_on_id><eventcode>CR4384</eventcode><add_on_desc>USJDP Jersey</add_on_desc><add_on_price>25.00</add_on_price><add_on_choices>S</add_on_choices><add_on_label>Sizes</add_on_label><order_number>CR-REG591891</order_number></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (add_on_id) to updateThere was no add_on_id specified in POST variablesResubmit request with add_on_id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editAnswerDescriptionEdit Answer details by id.UsageRequest MethodPOSTURIs/API/editAnswer/            Updates an Answer by id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>72</id><question_id>68</question_id><order_number>CR-REG641010</order_number><eventcode>1005</eventcode><answer>No</answer><assign_type/></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editMasterAccountDescriptionEdit Master Account details by IDUsageRequest MethodPOSTURIs/API/editMasterAccount/            Updates a Master Account by id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>402</id><accountnumber>144968</accountnumber><guard1_fname>Azuree</guard1_fname><guard1_lname>Struiksma</guard1_lname><guard1_address>123 Main Street</guard1_address><guard1_city>Los Angeles</guard1_city><guard1_state>CA</guard1_state><guard1_zip>90808</guard1_zip><guard1_country>US</guard1_country><guard1_phone>123.456.7890</guard1_phone><guard1_mobile>123.456.7892</guard1_mobile><guard1_work>123.456.7891</guard1_work><guard1_email>astruiksma@campfirelb.org</guard1_email><guard1_relation>-- Choose --</guard1_relation><guard2_fname/><guard2_lname/><guard2_address/><guard2_city/><guard2_state/><guard2_zip/><guard2_country>US</guard2_country><guard2_phone/><guard2_mobile/><guard2_work/><guard2_email/><guard2_relation>-- Choose --</guard2_relation><userid>astruiksma@campfirelb.org</userid><password>campfire</password><vault_pay_type>Yes</vault_pay_type><date_added>2010-03-23 15:51:26</date_added></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editParticipantDescriptionEdit Participant by IDUsageRequest MethodPOSTURIs/API/editParticipant            Updates a Participant by id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>50</id><master_id>576</master_id><firstname>Mary</firstname><middlename/><lastname>Benedett</lastname><dob>1992-01-01</dob><address>123 Main Street</address><city>Westminister</city><state>MD</state><zip>12345</zip><country>US</country><phone>404-456-7890</phone><email/><gender>Female</gender><relation_to_master/></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editPaymentDescriptionEdit Payment Information by IDUsageRequest MethodPOSTURIs/API/editPayment/            Updates a Payment by id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>303</id><trans_date>2010-04-27 11:24:02</trans_date><type>Credit Card</type><amount>385.00</amount><accountnumber>340528</accountnumber><eventcode>CR2198</eventcode><order_number>CR-REG886014</order_number><fname/><lname/><comment>Payment received in batch submission</comment><trans_id>1223020898</trans_id></data></xml>Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editProgramDescription Edit Program information by IDUsageRequest MethodPOSTURIs/API/editProgram/            Updates a Program by id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>275</id><eventcode>CR7665</eventcode><billing_code>123123</billing_code><eventdesc>Goal Keepers Camp </eventdesc><eventdesc_full>Elevate your level of play by learning key skills from our college and ODP coaching staff.  </eventdesc_full><sort_order>0</sort_order><eventdesc_sub>Bye Mike!</eventdesc_sub><reg_status>Active</reg_status><date>2012-07-21</date><date_end>2013-07-26</date_end><location>University of Denver</location><reg_insurance_amount>250.00</reg_insurance_amount><deposit_last_pay_date>2019-05-01</deposit_last_pay_date><staffbios>College and ODP coaches and all off-ice programs will be directed by the University of Denver Head Strength Coach Mike Sanders and Staff. </staffbios><onsite_contact_name>Bill Jones</onsite_contact_name><onsite_contact_email>Bill@DenverSoccer.com</onsite_contact_email><onsite_contact_phone>303.555.1212</onsite_contact_phone><facility_name>University of Denver</facility_name><facility_address>2201 Asbury Ave</facility_address><facility_city>Denver</facility_city><facility_state>CO</facility_state><facility_zip>80439</facility_zip><facility_url>www.du.edu</facility_url><facility_map_url></facility_map_url><daily_schedule>Sunday:7:15 - 8:15 pm - Evaluation Skate #1Monday - Friday:8:15 - 9:30 am - Weight Training10:00 - 11:30 am - On-Ice Session 111:45 am - Lunch12:45 pm - Seminars1:30 - 2:45 pm - Speed & Quickness Training3:10 - 4:40 pm - On-Ice Session 25:15 pm - Dinner6:00 - 7:00 pm - Rec Center Free Time7:45 - 8:45 pm - Specialty Ice SessionSaturday:9:45 - 10:45 am - Showcase Game</daily_schedule><daily_schedule2/><daily_schedule3/><daily_schedule4/><max_reg_camp>75</max_reg_camp><max_waitlist>5</max_waitlist><max_reg_position1>70</max_reg_position1><max_reg_position2>70</max_reg_position2><max_reg_position3>30</max_reg_position3><max_reg_position4>0</max_reg_position4><max_reg_position5>0</max_reg_position5><position1>Day Camper</position1><position2>Resident Camper</position2><position3>AM & PM Camper</position3><position4/><position5/><position1_price>395.00</position1_price><position2_price>625.00</position2_price><position3_price>700.00</position3_price><position4_price>0.00</position4_price><position5_price/><convenience_fee>7.00</convenience_fee><group1>Group 1</group1><group2>Group 2</group2><group3>Group 3</group3><group4>Group 4</group4><groups>Coach Smith,Coach Faust,Coach Anthony</groups><auto_email>0</auto_email><auto_email_type>0</auto_email_type><precamp_email>0</precamp_email><POSTcamp_email>0</POSTcamp_email><meta_info1/><meta_info2/><meta_info3/><meta_info4/><meta_info5/><show_carrier>Y</show_carrier><show_policy_no>Y</show_policy_no><show_group_name>Y</show_group_name><show_group_no>Y</show_group_no><show_physician>Y</show_physician><show_physician_phone>Y</show_physician_phone><show_fullname>Y</show_fullname><show_dob>Y</show_dob><show_email>Y</show_email><show_address>Y</show_address><show_city>Y</show_city><show_state>Y</show_state><show_POSTalcode>Y</show_POSTalcode><show_healthtitle>Y</show_healthtitle><show_insuredtitle>Y</show_insuredtitle><program_type>PC</program_type><skip_health>Y</skip_health><skip_addon>N</skip_addon><skip_questions>N</skip_questions><message_thankyou>Thank you for registering for the Goal Keepers Camp. Your registration has been received and will be processed for payment shortly.</message_thankyou><message_registrationpolicy>Registrations made BEFORE May 1, 2011:A deposit of $300 per week is required via MasterCard or Visa at time of registration. Deposits made for resident campers are non-refundable. Final payment is due May 1. The credit card used for the deposit payment will be charged for the remaining balance on May 1.<br><b>Registration AFTER May 1, 2010:</b><br>Full payment is due upon enrollment for any camp that has openings. No camper will be allowed to participate unless all fees have been paid and all health forms submitted in full. He Multiple Registration Policies option shown allow you to have up to three separate Registration Policy sections with individual section titles, text fields, and “I Acknowledge” check boxes. These “I Acknowledge” checkboxes prompt the user to check each box to indicate that they have read and understand that particular section. They cannot move past this page without all checkboxes being checked. You can use 1, 2 or all 3 sections shown here. </message_registrationpolicy><message_confirm>Congratulations! Your registration has been received and accepted for the Goal Keepers Camp. We will now process your account for payment.  You will receive a participant packet via email. If you have any questions in the meantime, please feel free to call us directly at 303.964.0929If you would like to enter, add or update an email address in your participant records, please email us at: Mike@USJDP.com.</message_confirm><message_decline>Your credit was declined when we attempted to process it for payment.  Please contact our office at 303.555.1212 about this ASAP.</message_decline><message_waitlist>Thank you for registering for the ODP Prep Camp. Unfortunately, at this time, the program you choose is full, and you have been added to our waitlist. You will be notified via email as soon as a spot becomes available.</message_waitlist><how_did_you_hear_about_us>Google,Word of mouth,Brochure,Friends,Other</how_did_you_hear_about_us><validate_questions>Yes</validate_questions><reg_cutoff_date>2999-01-01</reg_cutoff_date><daily_schedule5/><group5/><skip_econtact>N</skip_econtact><min_age>5</min_age><max_age>18</max_age><gender_restrict>Male</gender_restrict><strict_eligibility>1</strict_eligibility><reg_policy_title_1>Section 1 Title</reg_policy_title_1><reg_policy_title_2>Section 2 Title</reg_policy_title_2><reg_policy_title_3>Section 3 Title</reg_policy_title_3><reg_policy_1>Section 1 Text</reg_policy_1><reg_policy_2>Section 2 Text</reg_policy_2><reg_policy_3>Section 3 Text</reg_policy_3><allow_groups/><max_groups>0</max_groups><max_reg_per_group>0</max_reg_per_group><group_liability_level/><group_invite_message/><max_reg_position6>0</max_reg_position6><max_reg_position7>0</max_reg_position7><max_reg_position8>0</max_reg_position8><max_reg_position9>0</max_reg_position9><max_reg_position10>0</max_reg_position10><position6/><position7/><position8/><position9/><position10/><position6_price>0.00</position6_price><position7_price>0.00</position7_price><position8_price>0.00</position8_price><position9_price>0.00</position9_price><position10_price>0.00</position10_price><show_regdates>Y</show_regdates><min_grade>0</min_grade><max_grade>0</max_grade></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editPromoCodeDescriptionEdit Promo Code Information by IDUsageRequest MethodPOSTURIs/API/editPromoCode            Updates a Promo Code by id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>1</id><code>test</code><amount>10.00</amount><percentage/><type>Static Amount</type><valid_through>2013-07-25</valid_through><assign_code>'CR7665'</assign_code></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editQuestionDescriptionEdit Question information based on IDUsageRequest MethodPOSTURIs/API/editQuestion/            Updates a question based on id with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>136</id><eventcode>CR7665</eventcode><question_type>Text</question_type><question_choices/><question_index>2</question_index><question>What is your expected finish time?  Please enter in 00:00:00 format</question><require_validation>Yes</require_validation><internal_only>N</internal_only><assign_code>'CR8729'</assign_code><reg_status>Inactive</reg_status><assign_type>Participant</assign_type></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. editRegistrationDescriptionEdit Registration Information based on IDUsageRequest MethodPOSTURIs/API/editRegistration/            Updates Registration based on ID with POST variablesSuccess Data Structure<xml><status>1</status><message>Update Successful.</message><data><id>1156</id><eventdesc>Goal Keepers Camp </eventdesc><eventcode>CR7665</eventcode><participant_fname>Lisa</participant_fname><participant_lname>Faust</participant_lname><group/><status>Bill Me</status><order_number>CR-REG898332</order_number><billing_code>123123</billing_code><accountnumber>88116652</accountnumber><reg_date>2011-02-02 12:11:52</reg_date><participant_mname/><participant_phone>615-822-7826</participant_phone><email_primary/><dob>1980-04-05</dob><gender>Female</gender><position>Day Camper</position><price>695.00</price><address>123 Main Street</address><city>Nashville</city><state>TN</state><POSTal_code>30306</POSTal_code><country>US</country><promotional_code/><promotional_discount>0.00</promotional_discount><emergency_contact>Susan</emergency_contact><emergency_contact_phone>Galbreath</emergency_contact_phone><emergency_contact_relation>Mother</emergency_contact_relation><how_did_you_hear_about_us>Word of mouth</how_did_you_hear_about_us><health_insur_carrier/><health_policy/><health_group_name/><health_group/><health_dr_name/><health_dr_phone/><health_insured_name/><health_insured_dob/><health_insured_email/><health_insured_address/><health_insured_city/><health_insured_state/><health_insured_zip/><activity_log><B>Registration Confirmed</B> - 02/02/11<BR>Feb 2 2011 10:11:52  - BILL ME REGISTRATION<br />Registration Created.<br /></activity_log><deposit_paid>yes</deposit_paid><deposit_flag>yes</deposit_flag><deposit_amnt>250.00</deposit_amnt><confirmation_sent>0</confirmation_sent><confirmation_date>2011-02-02 12:23:58</confirmation_date><bill_me_flag>yes</bill_me_flag><form1_recvd>N</form1_recvd><form2_recvd>N</form2_recvd><form3_recvd>N</form3_recvd><form4_recvd>N</form4_recvd><form5_recvd>N</form5_recvd><POSTing_flag>POSTed</POSTing_flag><pay_plan>N</pay_plan><how_did_you_hear_other/><group_id>0</group_id><part_id/><session_date/></data></xml> Possible ErrorsError MessageCauseResolutionYou must specify a record ID (id) to updateThere was no id specified in POST variablesResubmit request with id specified in POST variablesOther sql error messagesBad POST data, truncated request, wrong data type used,Address message and resubmit request.  If error persists contact RegPoint Care Bears for assistance. viewAddOnsDescriptionGET add ons by idUsageRequest MethodGETURIs/api/viewAddOns/<apikey>/            Returns empty data structure/api/viewAddOns/<apikey>/ALL{?<filter>=<value>}            Returns all records {matching filter values}/api/viewAddOns/<apikey>/<id>{?<filter>=<value>}            Returns record for id {matching filter values}Success Data Structure<xml><add_ons><add_on><add_on_id/><eventcode/><add_on_desc/><add_on_price/><add_on_detail/><add_on_label/><add_on_choices/><image_name/><internal_only/><assign_code/><reg_status/></add_on></add_ons></xml> Possible ErrorsError MessageCauseResolution       viewAddonsPurchasedDescriptionGET add ons purchased by idUsageRequest MethodGETURIs/api/viewAddonsPurchased/<apikey>/            Returns empty data structure/api/viewAddonsPurchased/<apikey>/ALL{?<filter>=<value>}            Returns all records {matching filter values}/api/viewAddonsPurchased/<apikey>/<id>{?<filter>=<value>}            Returns record for id {matching filter values}Success Data Structure<xml><add_ons><add_on><add_on_id/><eventcode/><add_on_desc/><add_on_price/><add_on_choices/><add_on_label/><order_number/></add_on></add_ons></xml>Possible ErrorsError MessageCauseResolution       viewAnswersDescriptionGet answers by idUsageRequest MethodGETURI/api/ viewAnswers/<apikey>/            Returns empty data structure/api/ viewAnswers /<apikey>/ALL{?<filter>=<value>}            Returns all records {matching filter values}/api/ viewAnswers /<apikey>/<id>{?<filter>=<value>}            Returns record for id {matching filter values}Success Data Structure<xml><answers><answer><id/><question_id/><order_number/><eventcode/><answer/><assign_type/></answer></answers></xml>Possible Errors

Error Message

Cause

Resolution

 

 

 

 

 

 

 

viewMasterAccountParticipants

Description

Returns participants for a specified master account

Usage

Request Method

GET

URI

/api/viewparticipants/<apikey>/
            Returns empty data structure.

/api/viewparticipants/<apikey>/ALL{?filterkey=filtervalue}            Returns information for all participants {matching optional filters}./api/viewparticipants/<apikey>/<accountnumber>{?filterkey=filtervalue}            Returns all participants under the specified master account {matching optional filters}.Success Data Structure<xml><participants><participant><id/><master_id/><firstname/><middlename/><lastname/><dob/><address/><city/><state/><zip/><country/><phone/><email/><gender/><relation_to_master/></participant></participants></xml> Possible ErrorsError MessageCauseResolutionThe participants table is emptyThere are no records in the participants tableAdd a participant using the addparticipant functionThere are no participants matching the requested filters.There are records in the participants table; however, the filters will cause no data to be shown.Try removing some or all filtersThere are no participants for this account.There are no participants for this account.Add a participant using the addparticipant functionThat master account does not exist.The requested master account number does not exist in the database.Double check the master account number is correct and try again viewMasterAccountPaymentsDescriptionGet a list of payments for a specified master accountUsageRequest MethodGETURI/api/ viewMasterAccountPayments/<apikey>//api/ viewMasterAccountPayments /<apikey>/ALL{?<filter>=<value>}/api/ viewMasterAccountPayments /<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><payments><payment><id/><trans_date/><type/><amount/><accountnumber/><eventcode/><order_number/><fname/><lname/><comment/><trans_id/></payment></payments></xml>Possible Errors

Error Message

Cause

Resolution

 

 

 

 

 

 

 

viewMasterAccountRegistrations

Description

GET list of registrations for a master account

Usage

Request Method

GET

URI

/api/viewMasterAccountRegistrations/<apikey>/

/api/ viewMasterAccountRegistrations /<apikey>/ALL{?<filter>=<value>}/api/ viewMasterAccountRegistrations /<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><registrations><registration><id/><eventdesc/><eventcode/><participant_fname/><participant_lname/><group/><status/><order_number/><billing_code/><accountnumber/><reg_date/><participant_mname/><participant_phone/><email_primary/><dob/><gender/><position/><price/><address/><city/><state/><POSTal_code/><country/><promotional_code/><promotional_discount/><emergency_contact/><emergency_contact_phone/><emergency_contact_relation/><how_did_you_hear_about_us/><health_insur_carrier/><health_policy/><health_group_name/><health_group/><health_dr_name/><health_dr_phone/><health_insured_name/><health_insured_dob/><health_insured_email/><health_insured_address/><health_insured_city/><health_insured_state/><health_insured_zip/><activity_log/><deposit_paid/><deposit_flag/><deposit_amnt/><confirmation_sent/><confirmation_date/><bill_me_flag/><form1_recvd/><form2_recvd/><form3_recvd/><form4_recvd/><form5_recvd/><POSTing_flag/><pay_plan/><how_did_you_hear_other/><group_id/><part_id/><session_date/></registration></registrations></xml>Possible ErrorsError MessageCauseResolution       viewMasterAccountsDescriptionReturns master account information.NOTE: The user's password is not returned, nor can you filter by passwordUsageRequest MethodGETURIs/api/viewMasterAccounts/<apikey>/            Returns empty data structure./api/viewMasterAccounts/<apikey>/ALL{?filterkey=filtervalue}            Returns information for all accounts {matching optional filters}./api/viewMasterAccounts/<apikey>/<accountnumber>{?filterkey=filtervalue}            Returns information for the requested account {matching optional filters}.Success Data Structure<xml><master_accounts><master_account><id/><accountnumber/><guard1_fname/><guard1_lname/><guard1_address/><guard1_city/><guard1_state/><guard1_zip/><guard1_country/><guard1_phone/><guard1_mobile/><guard1_work/><guard1_email/><guard1_relation/><guard2_fname/><guard2_lname/><guard2_address/><guard2_city/><guard2_state/><guard2_zip/><guard2_country/><guard2_phone/><guard2_mobile/><guard2_work/><guard2_email/><guard2_relation/><userid/><vault_pay_type/><date_added/></master_account></master_accounts></xml> viewParticipantRegistrationsDescriptionGet a participant's registration history.  **NOTE:  Old systems will not do this correctly and should use viewMasterAccountRegistrations**UsageRequest MethodGETURI/api/viewParticipantRegistrations/<apikey>//api/ viewParticipantRegistrations /<apikey>/ALL{?<filter>=<value>}/api/ viewParticipantRegistrations /<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><registrations><registration><id/><eventdesc/><eventcode/><participant_fname/><participant_lname/><group/><status/><order_number/><billing_code/><accountnumber/><reg_date/><participant_mname/><participant_phone/><email_primary/><dob/><gender/><position/><price/><address/><city/><state/><POSTal_code/><country/><promotional_code/><promotional_discount/><emergency_contact/><emergency_contact_phone/><emergency_contact_relation/><how_did_you_hear_about_us/><health_insur_carrier/><health_policy/><health_group_name/><health_group/><health_dr_name/><health_dr_phone/><health_insured_name/><health_insured_dob/><health_insured_email/><health_insured_address/><health_insured_city/><health_insured_state/><health_insured_zip/><activity_log/><deposit_paid/><deposit_flag/><deposit_amnt/><confirmation_sent/><confirmation_date/><bill_me_flag/><form1_recvd/><form2_recvd/><form3_recvd/><form4_recvd/><form5_recvd/><POSTing_flag/><pay_plan/><how_did_you_hear_other/><group_id/><part_id/><session_date/></registration></registrations></xml> Possible ErrorsError MessageCauseResolution       viewParticipantsDescriptionReturns participants by idUsageRequest MethodGETURIs/api/viewparticipants/<apikey>/            Returns empty data structure./api/viewparticipants/<apikey>/ALL{?filterkey=filtervalue}            Returns information for all participants {matching optional filters}./api/viewparticipants/<apikey>/<id>{?filterkey=filtervalue}            Returns a participant for a specified id {matching optional filters}.Success Data Structure<xml><participants><participant><id/><master_id/><firstname/><middlename/><lastname/><dob/><address/><city/><state/><zip/><country/><phone/><email/><gender/><relation_to_master/></participant></participants></xml> Possible Errors

Error Message

Cause

Resolution

The participants table is empty

There are no records in the participants table

Add a participant using the addparticipant function

There are no participants matching the requested filters.

There are records in the participants table; however, the filters will cause no data to be shown.

Try removing some or all filters

There are no participants for this account.

There are no participants for this account.

Add a participant using the addparticipant function

That master account does not exist.

The requested master account number does not exist in the database.

Double check the master account number is correct and try again

 

viewPayments

Description

Get payments by id

Usage

Request Method

GET

URIs

/api/viewPayments/<apikey>/

/api/viewPayments/<apikey>/ALL{?<filter>=<value>}/api/viewPayments/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><participants><participant><id/><master_id/><firstname/><middlename/><lastname/><dob/><address/><city/><state/><zip/><country/><phone/><email/><gender/><relation_to_master/></participant></participants></xml>Possible ErrorsError MessageCauseResolution       viewProgramAddOnsDescriptionReturns addons associated with a programUsageRequest MethodGETURI/api/viewProgramAddOns/<apikey>/            Returns empty data structure./api/viewProgramAddOns/<apikey>/ALL{?filterkey=filtervalue}            Returns all add ons {matching optional filters}./api/viewProgramAddOns/<apikey>/<eventcode>{?filterkey=filtervalue}            Returns add ons for the requested event {matching optional filters}.Success Data Structure<xml><add_ons><add_on><add_on_id/><eventcode/><add_on_desc/><add_on_price/><add_on_detail/><add_on_label/><add_on_choices/><image_name/><internal_only/><assign_code/><reg_status/></add_on></add_ons></xml>Possible ErrorsError MessageCauseResolutionThere are no add onsThe add ons table is emptyCreate an add on using createProgramAddOn    viewProgramAddOnsPurchasedDescriptionGet addons purchased per programUsageRequest MethodGETURIs/api/ viewProgramAddOnsPurchased/<apikey>//api/ viewProgramAddOnsPurchased/<apikey>/ALL{?<filter>=<value>}/api/ viewProgramAddOnsPurchased/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><add_ons_purchased><add_on><add_on_id>int</add_on_id><eventcode>varchar</eventcode><add_on_desc>varchar</add_on_desc><add_on_price>decimal</add_on_price><add_on_choices>varchar</add_on_choices><add_on_label>varchar</add_on_label><order_number>varchar</order_number></add_on></add_ons_purchased></xml> Possible ErrorsError MessageCauseResolution       viewProgramAnswersDescriptionUsageRequest MethodGETURIs/api/viewProgramAnswers/<apikey>//api/viewProgramAnswers/<apikey>/ALL{?<filter>=<value>}/api/viewProgramAnswers/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><reg_answers><reg_answer><id>int</id><question_id>int</question_id><order_number>varchar</order_number><eventcode>varchar</eventcode><answer>varchar</answer><assign_type>varchar</assign_type></reg_answer></reg_answers></xml> Possible ErrorsError MessageCauseResolution       viewProgramPaymentsDescriptionUsageRequest MethodGETURIs/api/viewProgramPayments/<apikey>//api/viewProgramPayments/<apikey>/ALL{?<filter>=<value>}/api/viewProgramPayments/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><payments><payment><id>int</id><trans_date>timestamp</trans_date><type>varchar</type><amount>decimal</amount><accountnumber>int</accountnumber><eventcode>varchar</eventcode><order_number>varchar</order_number><fname>varchar</fname><lname>varchar</lname><comment>varchar</comment><trans_id>varchar</trans_id></payment></payments></xml> Possible Errors

Error Message

Cause

Resolution

 

 

 

 

 

 

 

viewProgramPromoCodes

Description

Usage

Request Method

GET

URIs

/api/viewProgramPromoCodes/<apikey>/

/api/viewProgramPromoCodes/<apikey>/ALL{?<filter>=<value>}/api/viewProgramPromoCodes/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><promo_codes><promo_code><id>int</id><code>varchar</code><amount>decimal</amount><percentage>decimal</percentage><type>varchar</type><valid_through>date</valid_through><assign_code>text</assign_code></promo_code></promo_codes></xml> Possible ErrorsError MessageCauseResolution       viewProgramQuestionsDescriptionUsageRequest MethodGETURIs/api/viewProgramQuestions/<apikey>//api/viewProgramQuestions/<apikey>/ALL{?<filter>=<value>}/api/viewProgramQuestions/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><reg_questions><reg_question><id>int</id><eventcode>varchar</eventcode><question_type>varchar</question_type><question_choices>text</question_choices><question_index>int</question_index><question>text</question><require_validation>varchar</require_validation><internal_only>varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status><assign_type>varchar</assign_type></reg_question></reg_questions></xml> Possible ErrorsError MessageCauseResolution       viewProgramRegistrationsDescriptionReturns registrations for a given programUsageRequest MethodGETRequest URLs/api/viewProgramRegistrations/<apikey>/            Returns empty data structure./api/viewProgramRegistrations/<apikey>/ALL{?filterkey=filtervalue}            Returns information for all registrations {matching optional filters}./api/viewProgramRegistrations/<apikey>/<eventcode>{?filterkey=filtervalue}            Returns all registrations under the specified program {matching optional filters}.Success Data Structure<xml><registrations><registration><id/><eventdesc/><eventcode/><participant_fname/><participant_lname/><group/><status/><order_number/><billing_code/><accountnumber/><reg_date/><participant_mname/><participant_phone/><email_primary/><dob/><gender/><position/><price/><address/><city/><state/><POSTal_code/><country/><promotional_code/><promotional_discount/><emergency_contact/><emergency_contact_phone/><emergency_contact_relation/><how_did_you_hear_about_us/><health_insur_carrier/><health_policy/><health_group_name/><health_group/><health_dr_name/><health_dr_phone/><health_insured_name/><health_insured_dob/><health_insured_email/><health_insured_address/><health_insured_city/><health_insured_state/><health_insured_zip/><activity_log/><deposit_paid/><deposit_flag/><deposit_amnt/><confirmation_sent/><confirmation_date/><bill_me_flag/><form1_recvd/><form2_recvd/><form3_recvd/><form4_recvd/><form5_recvd/><POSTing_flag/><pay_plan/><how_did_you_hear_other/><group_id/><part_id/><session_date/></registration></registrations></xml> viewProgramsDescriptionReturns a list of programs matching a given eventcodeUsageRequest MethodGETURIs/api/viewprograms/<apikey>/            Returns empty data structure./api/viewprograms/<apikey>/ALL{?filterkey=filtervalue}            Returns all programs {matching optional filters}./api/viewprograms/<apikey>/<eventcode>{?filterkey=filtervalue}            Returns program matching eventcode {matching optional filters}.Success Data Structure<xml><programs><program><id>int</id><eventcode>varchar</eventcode><billing_code>varchar</billing_code><eventdesc>varchar</eventdesc><eventdesc_full>text</eventdesc_full><sort_order>int</sort_order><eventdesc_sub>varchar</eventdesc_sub><reg_status>varchar</reg_status><date>date</date><date_end>date</date_end><location>varchar</location><reg_insurance_amount>decimal</reg_insurance_amount><deposit_last_pay_date>date</deposit_last_pay_date><staffbios>text</staffbios><onsite_contact_name>varchar</onsite_contact_name><onsite_contact_email>varchar</onsite_contact_email><onsite_contact_phone>varchar</onsite_contact_phone><facility_name>varchar</facility_name><facility_address>varchar</facility_address><facility_city>varchar</facility_city><facility_state>varchar</facility_state><facility_zip>varchar</facility_zip><facility_url>varchar</facility_url><facility_map_url>text</facility_map_url><daily_schedule>text</daily_schedule><daily_schedule2>text</daily_schedule2><daily_schedule3>text</daily_schedule3><daily_schedule4>text</daily_schedule4><max_reg_camp>int</max_reg_camp><max_waitlist>int</max_waitlist><max_reg_position1>int</max_reg_position1><max_reg_position2>int</max_reg_position2><max_reg_position3>int</max_reg_position3><max_reg_position4>int</max_reg_position4><max_reg_position5>int</max_reg_position5><position1>varchar</position1><position2>varchar</position2><position3>varchar</position3><position4>varchar</position4><position5>varchar</position5><position1_price>decimal</position1_price><position2_price>decimal</position2_price><position3_price>decimal</position3_price><position4_price>decimal</position4_price><position5_price>varchar</position5_price><convenience_fee>decimal</convenience_fee><group1>varchar</group1><group2>varchar</group2><group3>varchar</group3><group4>varchar</group4><groups>varchar</groups><auto_email>int</auto_email><auto_email_type>int</auto_email_type><precamp_email>int</precamp_email><postcamp_email>int</postcamp_email><meta_info1>varchar</meta_info1><meta_info2>varchar</meta_info2><meta_info3>varchar</meta_info3><meta_info4>varchar</meta_info4><meta_info5>varchar</meta_info5><show_carrier>varchar</show_carrier><show_policy_no>varchar</show_policy_no><show_group_name>varchar</show_group_name><show_group_no>varchar</show_group_no><show_physician>varchar</show_physician><show_physician_phone>varchar</show_physician_phone><show_fullname>varchar</show_fullname><show_dob>varchar</show_dob><show_email>varchar</show_email><show_address>varchar</show_address><show_city>varchar</show_city><show_state>varchar</show_state><show_postalcode>varchar</show_postalcode><show_healthtitle>varchar</show_healthtitle><show_insuredtitle>varchar</show_insuredtitle><program_type>varchar</program_type><skip_health>varchar</skip_health><skip_addon>varchar</skip_addon><skip_questions>varchar</skip_questions><message_thankyou>text</message_thankyou><message_registrationpolicy>text</message_registrationpolicy><message_confirm>text</message_confirm><message_decline>text</message_decline><message_waitlist>text</message_waitlist><how_did_you_hear_about_us>varchar</how_did_you_hear_about_us><validate_questions>varchar</validate_questions><reg_cutoff_date>date</reg_cutoff_date><daily_schedule5>text</daily_schedule5><group5>varchar</group5><skip_econtact>varchar</skip_econtact><min_age>int</min_age><max_age>int</max_age><gender_restrict>varchar</gender_restrict><strict_eligibility>tinyint</strict_eligibility><reg_policy_title_1>varchar</reg_policy_title_1><reg_policy_title_2>varchar</reg_policy_title_2><reg_policy_title_3>varchar</reg_policy_title_3><reg_policy_1>text</reg_policy_1><reg_policy_2>text</reg_policy_2><reg_policy_3>text</reg_policy_3><allow_groups>varchar</allow_groups><max_groups>int</max_groups><max_reg_per_group>int</max_reg_per_group><group_liability_level>varchar</group_liability_level><group_invite_message>text</group_invite_message><max_reg_position6>int</max_reg_position6><max_reg_position7>int</max_reg_position7><max_reg_position8>int</max_reg_position8><max_reg_position9>int</max_reg_position9><max_reg_position10>int</max_reg_position10><position6>varchar</position6><position7>varchar</position7><position8>varchar</position8><position9>varchar</position9><position10>varchar</position10><position6_price>decimal</position6_price><position7_price>decimal</position7_price><position8_price>decimal</position8_price><position9_price>decimal</position9_price><position10_price>decimal</position10_price><show_regdates>varchar</show_regdates><min_grade>int</min_grade><max_grade>int</max_grade></program><program/></programs></xml> viewPromoCodesDescriptionUsageRequest MethodGETURIs/api/viewPromoCodes/<apikey>//api/viewPromoCodes/<apikey>/ALL{?<filter>=<value>}/api/viewPromoCodes/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><promo_codes><promo_code><id>int</id><code>varchar</code><amount>decimal</amount><percentage>decimal</percentage><type>varchar</type><valid_through>date</valid_through><assign_code>text</assign_code></promo_code></promo_codes></xml> Possible ErrorsError MessageCauseResolution       viewQuestionsDescriptionUsageRequest MethodGETURIs/api/viewQuestions/<apikey>//api/viewQuestions/<apikey>/ALL{?<filter>=<value>}/api/viewQuestions/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><questions><question><id>int</id><eventcode>varchar</eventcode><question_type>varchar</question_type><question_choices>text</question_choices><question_index>int</question_index><question>text</question><require_validation>varchar</require_validation><internal_only>varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status><assign_type>varchar</assign_type></question></questions></xml> Possible ErrorsError MessageCauseResolution       viewRegistrationInformationDescriptionGets all information associated with a particular registration order numberUsageRequest MethodGETURIs/api/viewRegistrationInformation/<apikey>//api/viewRegistrationInformation/<apikey>/ALL{?<filter>=<value>}/api/viewRegistrationInformation/<apikey>/<ordernumber>{?<filter>=<value>}Success Data Structure<xml><registration><id>int</id><eventdesc>varchar</eventdesc><eventcode>varchar</eventcode><participant_fname>varchar</participant_fname><participant_lname>varchar</participant_lname><group>varchar</group><status>varchar</status><order_number>varchar</order_number><billing_code>varchar</billing_code><accountnumber>int</accountnumber><reg_date>timestamp</reg_date><participant_mname>varchar</participant_mname><participant_phone>varchar</participant_phone><email_primary>varchar</email_primary><dob>varchar</dob><gender>varchar</gender><position>varchar</position><price>decimal</price><address>varchar</address><city>varchar</city><state>varchar</state><postal_code>varchar</postal_code><country>varchar</country><promotional_code>varchar</promotional_code><promotional_discount>decimal</promotional_discount><emergency_contact>varchar</emergency_contact><emergency_contact_phone>varchar</emergency_contact_phone><emergency_contact_relation>varchar</emergency_contact_relation><how_did_you_hear_about_us>varchar</how_did_you_hear_about_us><health_insur_carrier>varchar</health_insur_carrier><health_policy>varchar</health_policy><health_group_name>varchar</health_group_name><health_group>varchar</health_group><health_dr_name>varchar</health_dr_name><health_dr_phone>varchar</health_dr_phone><health_insured_name>varchar</health_insured_name><health_insured_dob>varchar</health_insured_dob><health_insured_email>varchar</health_insured_email><health_insured_address>varchar</health_insured_address><health_insured_city>varchar</health_insured_city><health_insured_state>varchar</health_insured_state><health_insured_zip>varchar</health_insured_zip><activity_log>text</activity_log><deposit_paid>varchar</deposit_paid><deposit_flag>varchar</deposit_flag><deposit_amnt>decimal</deposit_amnt><confirmation_sent>int</confirmation_sent><confirmation_date>timestamp</confirmation_date><bill_me_flag>varchar</bill_me_flag><form1_recvd>varchar</form1_recvd><form2_recvd>varchar</form2_recvd><form3_recvd>varchar</form3_recvd><form4_recvd>varchar</form4_recvd><form5_recvd>varchar</form5_recvd><posting_flag>varchar</posting_flag><pay_plan>varchar</pay_plan><how_did_you_hear_other>varchar</how_did_you_hear_other><group_id>int</group_id><part_id>int</part_id><session_date>datetime</session_date><add_ons><add_on><add_on_id>int</add_on_id><eventcode>varchar</eventcode><add_on_desc>varchar</add_on_desc><add_on_price>decimal</add_on_price><add_on_detail>text</add_on_detail><add_on_label>varchar</add_on_label><add_on_choices>varchar</add_on_choices><image_name>varchar</image_name><internal_only>varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status></add_on></add_ons><questions><question><id>int</id><eventcode>varchar</eventcode><question_type>varchar</question_type><question_choices>text</question_choices><question_index>int</question_index><question>text</question><require_validation>varchar</require_validation><internal_only>varchar</internal_only><assign_code>text</assign_code><reg_status>varchar</reg_status><assign_type>varchar</assign_type></question></questions><answers><answer><id>int</id><question_id>int</question_id><order_number>varchar</order_number><eventcode>varchar</eventcode><answer>varchar</answer><assign_type>varchar</assign_type></answer></answers><payments><payment><id>int</id><trans_date>timestamp</trans_date><type>varchar</type><amount>decimal</amount><accountnumber>int</accountnumber><eventcode>varchar</eventcode><order_number>varchar</order_number><fname>varchar</fname><lname>varchar</lname><comment>varchar</comment><trans_id>varchar</trans_id></payment></payments><promo_code><id>int</id><code>varchar</code><amount>decimal</amount><percentage>decimal</percentage><type>varchar</type><valid_through>date</valid_through><assign_code>text</assign_code></promo_code></registration></xml> Possible Errors

Error Message

Cause

Resolution

 

 

 

 

 

 

 

viewRegistrationPayments

Description

Usage

Request Method

GET

URIs

/api/viewRegistrationPayments/<apikey>/

/api/viewRegistrationPayments/<apikey>/ALL{?<filter>=<value>}/api/viewRegistrationPayments/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><payments><payment><id>int</id><trans_date>timestamp</trans_date><type>varchar</type><amount>decimal</amount><accountnumber>int</accountnumber><eventcode>varchar</eventcode><order_number>varchar</order_number><fname>varchar</fname><lname>varchar</lname><comment>varchar</comment><trans_id>varchar</trans_id></payment></payments></xml> Possible ErrorsError MessageCauseResolution       viewRegistrationsDescriptionUsageRequest MethodGETURIs/api/viewRegistrations/<apikey>//api/viewRegistrations/<apikey>/ALL{?<filter>=<value>}/api/viewRegistrations/<apikey>/<id>{?<filter>=<value>}Success Data Structure<xml><registrations><registration><id>int</id><eventdesc>varchar</eventdesc><eventcode>varchar</eventcode><participant_fname>varchar</participant_fname><participant_lname>varchar</participant_lname><group>varchar</group><status>varchar</status><order_number>varchar</order_number><billing_code>varchar</billing_code><accountnumber>int</accountnumber><reg_date>timestamp</reg_date><participant_mname>varchar</participant_mname><participant_phone>varchar</participant_phone><email_primary>varchar</email_primary><dob>varchar</dob><gender>varchar</gender><position>varchar</position><price>decimal</price><address>varchar</address><city>varchar</city><state>varchar</state><postal_code>varchar</postal_code><country>varchar</country><promotional_code>varchar</promotional_code><promotional_discount>decimal</promotional_discount><emergency_contact>varchar</emergency_contact><emergency_contact_phone>varchar</emergency_contact_phone><emergency_contact_relation>varchar</emergency_contact_relation><how_did_you_hear_about_us>varchar</how_did_you_hear_about_us><health_insur_carrier>varchar</health_insur_carrier><health_policy>varchar</health_policy><health_group_name>varchar</health_group_name><health_group>varchar</health_group><health_dr_name>varchar</health_dr_name><health_dr_phone>varchar</health_dr_phone><health_insured_name>varchar</health_insured_name><health_insured_dob>varchar</health_insured_dob><health_insured_email>varchar</health_insured_email><health_insured_address>varchar</health_insured_address><health_insured_city>varchar</health_insured_city><health_insured_state>varchar</health_insured_state><health_insured_zip>varchar</health_insured_zip><activity_log>text</activity_log><deposit_paid>varchar</deposit_paid><deposit_flag>varchar</deposit_flag><deposit_amnt>decimal</deposit_amnt><confirmation_sent>int</confirmation_sent><confirmation_date>timestamp</confirmation_date><bill_me_flag>varchar</bill_me_flag><form1_recvd>varchar</form1_recvd><form2_recvd>varchar</form2_recvd><form3_recvd>varchar</form3_recvd><form4_recvd>varchar</form4_recvd><form5_recvd>varchar</form5_recvd><posting_flag>varchar</posting_flag><pay_plan>varchar</pay_plan><how_did_you_hear_other>varchar</how_did_you_hear_other><group_id>int</group_id><part_id>int</part_id><session_date>datetime</session_date></registration></registrations></xml> Possible Errors

Error Message

Cause

Resolution