WEBCentralizedShoppingCartEventRegistrantGroupGet
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
object |
This method is used to select an existing Event Group Registration.
See XWeb Event Group Registration for a complete walk-through of how to create an Events Group Registration in xWeb.
Parameters
Key (guid). - this is the key of the group registration.
Response
Group Registration Object - a group registration object with the data for the group populated. The list of current registrants in the group is not included.
Sample Request
<<SAMPLE REQUEST>>
Sample Response
<<SAMPLE RESPONSE>>
JSON Method
Get the group event registration object by its group key (egp_key).
-
Use this API call to get the Group Registration object needed for other shopping cart calls.
-
The returned group event registration object can be used in the following API calls:
-
WEBCentralizedShoppingCartAddEventRegistrantToGroup
-
WEBCentralizedShoppingCartRemoveEventRegistrantFromGroup
-
WEBCentralizedShoppingCartAddEventRegistrantGroup
-
-
This is needed for some shopping cart API calls.
-
If the key is not found, a blank group will be returned. This is identifiable because the egp_evt_key will not be present in the Group_Registration block.
-
Use WEBCentralizedShoppingCartEventRegistrantGroupGetNew to create a new group registration.
GET /xweb/JSON/WEBCentralizedShoppingCartEventRegistrantGroupGet?Key=032E5656-A0CD-4FD9-8F8F-3747D7D64D3C
POST /xweb/JSON/WEBCentralizedShoppingCartEventRegistrantGroupGet
Copy
DATA: JSON
{
"WEBCentralizedShoppingCartEventRegistrantGroupGet": {
"Key": "032E5656-A0CD-4FD9-8F8F-3747D7D64D3C"
}
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"EventsRegistrantGroupType": {
"CurrentKey": "032e5656-a0cd-4fd9-8f8f-3747d7d64d3c",
"Group_Registration": {
"egp_key": "032e5656-a0cd-4fd9-8f8f-3747d7d64d3c",
"egp_org_cst_key": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"egp_evt_key": "c73a3aa5-42d4-4cc5-adfd-e61107eee074",
"egp_add_user": "user",
"egp_add_date": "2020-03-24T13:48:52-04:00",
"egp_delete_flag": "0",
"egp_key_ext": "032e5656-a0cd-4fd9-8f8f-3747d7d64d3c",
"egp_inv_code": "408716",
"egp_registration_date": "2020-03-24T00:00:00-04:00",
"egp_cxa_key": "55ce31ce-943c-4380-a8f1-9f5c0ef741cc",
"egp_cph_key": "5a899dfb-6660-460d-84f3-51df203ea4c4",
"egp_eml_key": "89db33c3-2b51-4f65-84d2-153099d6c13b",
"egp_rgt_key": "8853f5ad-2f09-475c-8230-ffdff94c170d",
"egp_number_of_registrants": "0"
},
"Organization": {
"org_consortia_flag": "0",
"org_cst_key": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"org_name": "Test Org A",
"org_ogt_code": "Hospital",
"org_cst_key_ext": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"org_num_employee": "5",
"org_add_date": "2019-02-20T13:14:00-05:00",
"org_nonprofit_flag": "0",
"org_add_user": "user",
"org_change_date": "2020-03-24T11:38:47-04:00",
"org_change_user": "web:zzchapterChamp@gmail.comzz",
"org_fiscal_year_ext": "July",
"org_delete_flag": "0",
"org_population_served_ext": "1",
"org_purchasing_volume_ext": "10.00",
"org_select_flag": "0"
},
"Customer": {
"cst_key": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"cst_type": "Organization",
"cst_name_cp": "Test Org A",
"cst_sort_name_dn": "Test Org A",
"cst_org_name_dn": "Test Org A",
"cst_add_date": "2019-02-20T13:14:00-05:00",
"cst_add_user": "user",
"cst_change_date": "2020-03-24T11:39:00-04:00",
"cst_change_user": "web:zzchapterChamp@gmail.comzz",
"cst_delete_flag": "0",
"cst_recno": "223399",
"cst_id": "000223399O",
"cst_key_ext": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"cst_email_text_only": "0",
"cst_tax_exempt_flag": "0",
"cst_cxa_key": "55ce31ce-943c-4380-a8f1-9f5c0ef741cc",
"cst_no_email_flag": "0",
"cst_eml_address_dn": "zzdfkahds@gmail.comzz",
"cst_eml_key": "89db33c3-2b51-4f65-84d2-153099d6c13b",
"cst_no_phone_flag": "0",
"cst_phn_number_complete_dn": "(703)703-7030",
"cst_cph_key": "5a899dfb-6660-460d-84f3-51df203ea4c4",
"cst_no_fax_flag": "0",
"cst_no_web_flag": "0",
"cst_member_flag": "1",
"cst_no_msg_flag": "0",
"cst_chp_memb_ext": "Arizona State Capitol Chapter of Client",
"cst_no_mail_flag": "0",
"cst_web_force_password_change": "0",
"cst_web_login_disabled_flag": "0",
"cst_credit_hold_flag": "0",
"cst_web_forgot_password_status": "0",
"cst_no_publish_flag": "0",
"cst_exclude_from_social_flag": "0",
"cst_credit_available": "0.00",
"cst_receives_member_benefits_flag": "0"
},
"Individual_X_Organization": {
"ixo_primary": "0",
"ixo_owner": "0"
},
"Individual": null,
"Address": {
"adr_key": "2cfbf844-af3f-4da8-8335-8ae7d81713f1",
"adr_cst_key_owner": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"adr_line1": "123 Test Street",
"adr_city": "Testville",
"adr_state": "VA",
"adr_post_code": "20171",
"adr_city_state_code": "Testville, VA 20171",
"adr_country": "UNITED STATES",
"adr_add_date": "2019-02-20T13:13:45-05:00",
"adr_add_user": "user",
"adr_delete_flag": "0",
"adr_key_ext": "2cfbf844-af3f-4da8-8335-8ae7d81713f1",
"adr_bad_address_flag": "0",
"adr_no_validation_flag": "0"
},
"Address_XRef": {
"cxa_cst_key": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"cxa_adr_key": "2cfbf844-af3f-4da8-8335-8ae7d81713f1",
"cxa_add_date": "2019-02-20T13:14:00-05:00",
"cxa_add_user": "user",
"cxa_delete_flag": "0",
"cxa_key": "55ce31ce-943c-4380-a8f1-9f5c0ef741cc",
"cxa_key_ext": "55ce31ce-943c-4380-a8f1-9f5c0ef741cc",
"cxa_on_hold_flag": "0",
"cxa_adt_key": "e09fc2cf-5f86-46cd-9c31-f215018ba99f",
"cxa_mailing_label": "Test Org A 123 Test Street Testville, VA 20171",
"cxa_mailing_label_html": "Test Org A<br>123 Test Street<br>Testville, VA 20171",
"cxa_primary": "1",
"cxa_owner": "1",
"cxa_billing": "0",
"cxa_create_change_log": "0"
},
"Email": {
"eml_key": "89db33c3-2b51-4f65-84d2-153099d6c13b",
"eml_address": "zzdfkahds@gmail.comzz",
"eml_cst_key": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"eml_type": "business",
"eml_add_user": "web:tonyyu77@gmail.com",
"eml_add_date": "2019-06-21T12:14:14-04:00",
"eml_delete_flag": "0",
"eml_key_ext": "89db33c3-2b51-4f65-84d2-153099d6c13b",
"eml_invalid_flag": "0",
"eml_unlisted_flag": "0",
"eml_primary": "0"
},
"Website": {
"url_type": "internet",
"url_primary": "1"
},
"Messaging": {
"msg_primary": "1"
},
"Phone": {
"phn_key": "c8429b9a-c902-4ab5-b538-33f38ca4fa0a",
"phn_cst_key_owner": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"phn_number": "7037037030",
"phn_number_display": "(703)703-7030",
"phn_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"phn_add_user": "user",
"phn_add_date": "2019-02-20T13:13:44-05:00",
"phn_delete_flag": "0",
"phn_key_ext": "c8429b9a-c902-4ab5-b538-33f38ca4fa0a"
},
"Phone_XRef": {
"cph_key": "5a899dfb-6660-460d-84f3-51df203ea4c4",
"cph_cst_key": "a83a916e-7a5b-499b-a6c5-3e31a8291743",
"cph_phn_key": "c8429b9a-c902-4ab5-b538-33f38ca4fa0a",
"cph_pht_key": "88ff5661-2d14-4bdf-be4c-906c3bff7ef7",
"cph_add_user": "user",
"cph_add_date": "2019-02-20T13:13:44-05:00",
"cph_delete_flag": "0",
"cph_key_ext": "5a899dfb-6660-460d-84f3-51df203ea4c4",
"cph_unlisted_flag": "0",
"cph_phn_number_complete": "(703)703-7030",
"cph_primary": "1",
"cph_owner": "1"
},
"Fax": {
"fax_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Fax_XRef": {
"cfx_fxt_key": "6b632577-c4ef-42ac-ae19-6dfe0ddece4b",
"cfx_primary": "1",
"cfx_owner": "1"
},
"Event": {
"evt_key": "c73a3aa5-42d4-4cc5-adfd-e61107eee074",
"evt_code": "S",
"evt_etp_key": "f814100d-2fc3-4ac2-9efa-aee17154ca90",
"evt_title": "PACORE 110920 Columbus, OH",
"evt_capacity": "20",
"evt_wait_list_flag": "0",
"evt_registration_required": "1",
"evt_restricted": "0",
"evt_short_description": "Core Certificate: Foundations of Planning & Analysis 11/09/20 Columbus, OH ",
"evt_description_html": "<p>For the public procurement professional, the ability to think strategically for both the procurement function and the larger governmental entity as a whole is critical to serving the communities in which we live and work. Designed to outline proactive, applicable approaches to ensuring best practice guidance and implementation, Client’s Foundations of Planning and Analysis Core Certificate empowers novice public procurement professionals to better identify and articulate the goals and objectives of public procurement. Outlining and exploring critical skills such as strength and weakness evaluation, opportunities and threat analysis, and stakeholder-end user engagement, the Foundations of Planning and Analysis certificate prepares learners with base-level interactive and exercise-driven instruction, providing best practice guidance to help you not only lead your entity to successful risk-averse strategy but also to secure the best benefit for stakeholders and communities alike. </p> <p><a href=\"https://www.Client.org/home/your-learning-journey/education/catalog-courses/core-certificate-foundations-of-planning-and-analysis \">Course Description</a></p>",
"evt_start_date": "2020-11-09T00:00:00-05:00",
"evt_start_time": "8:00 AM",
"evt_end_date": "2020-11-10T00:00:00-05:00",
"evt_end_time": "5:00 PM",
"evt_early_registration_date": "2020-09-10T00:00:00-04:00",
"evt_late_registration_date": "2020-10-26T00:00:00-04:00",
"evt_cutoff_date": "2020-10-10T00:00:00-04:00",
"evt_post_to_web_date": "2020-01-23T00:00:00-05:00",
"evt_remove_from_web_date": "2020-11-10T00:00:00-05:00",
"evt_add_user": "user",
"evt_add_date": "2020-01-23T14:23:46-05:00",
"evt_change_user": "user",
"evt_change_date": "2020-01-23T14:39:55-05:00",
"evt_delete_flag": "0",
"evt_key_ext": "c73a3aa5-42d4-4cc5-adfd-e61107eee074",
"evt_cct_key": "c32616d1-4376-4e7a-ace6-ed1626c8cd80",
"evt_tzn_key": "059930c3-7d4e-46d9-8a59-e3c95a2a19cd",
"evt_etc_key": "38f92003-08de-43c4-9511-ed437ec43c89",
"evt_abstract_flag": "0",
"evt_closed_flag": "0",
"evt_free_event_flag": "0",
"evt_regid_counter": "2",
"evt_free_guest_flag": "0",
"evt_charity_event_flag": "0",
"evt_activity_type_ext": "Chapter- Pathways",
"evt_contact_hours_ext": "15.00",
"evt_firsttimer_fullconf_flag_ext": "0",
"evt_firsttimer_confonly_flag_ext": "0",
"evt_n18_key_ext": "b15a09b5-e73b-40ab-b620-358dccb2553b",
"evt_accreditation_ext": "Accredited",
"evt_ceu_hours_ext": "1.50",
"evt_reg_payment_info_html_ext": "<h2>Course Fees / Pre-Registration Required</h2> <p><strong>Standard pricing:</strong></p> <p>Institute Members - $425 **<br /> Non-Members - $525 **</p> <p>** Receive a $25 early registration discount by registering 60 or more days in advance of the course. A late fee of $50 will be assessed for those registrations received within 30 days of the course.</p> <p>Not a Client Institute member? <a href=\"http://www.Client.org/home/membership\">Click here</a> for membership information. </p><p> </p> <br /> <h2>Registration & Payment Information</h2> <p><strong>Register online with credit card by clicking the register button below<br />Register by fax (<a href=\"http://www.Client.org/docs/default-source/New-Site/chapters/resource-center/chapter-seminar-registration-form-fy-2017.pdf?sfvrsn=2\">Download print and fax form</a>)</strong></p> <p><strong>*FORM OF PAYMENT MUST ACCOMPANY REGISTRATION FORM FOR ORDER TO BE PROCESSED</strong></p> <p><strong>Methods of Payment Accepted:</strong> Check (make checks payable to Client), Purchase Orders (via print and fax form), and Credit Cards (Master Card, Visa, and American Express).</p> <p>If paying by check, please make check payable to Client and send payment to:</p> <p>Client, Attn: Seminar Registration<br />2411 Dulles Corner Park, Suite 350<br />Herndon, VA 20171</p>",
"evt_cancel_policy_html_ext": "<h2>Client Course Cancellation Policy</h2> <p>Registration and payment must be received 30 days prior to the seminar start date. After this time, registrations will be based on space availability. A full refund, less a <strong>$75 administrative fee</strong> will be given for cancellations made in writing 31+ days prior to the seminar date by emailing <a href=\"mailto:RegistrationInfo@nigp.org\">RegistrationInfo@Client.org</a>. No refunds are given for cancellations received within 30 days of the seminar start date. There are no refunds for no-shows. If the seminar is cancelled for any reason, Client's liability is limited to the registration fee only. </p><p>Attendee substitutions within the same agency may be done at any time with email notification to Client. If attending via scholarship, please provide documentation verifying the scholarship issuer's name and contact information in lieu of payment information.</p>",
"evt_local_info_ext": "<h2>Local Information</h2> <p>If you would like more information on the event, please contact the local Seminar Coordinator, Kenzie Nickell via email at <a href=\"mailto:\">mackenzie.nickell@das.ohio.gov</a> </p>",
"evt_registered": "0",
"evt_onwaitlist": "0",
"evt_available": "20",
"evt_remaining": "20",
"evt_available_new": "20",
"evt_Registered_main_count": "0",
"evt_waitList_main_count": "0",
"evt_Registered_guest_count": "0",
"evt_waitList_guest_count": "0",
"evt_payables_batch_suffix": "BATCH"
},
"Event_Location_Room_Type": null,
"Room_Request": null,
"Invoice": {
"inv_print_count": "0",
"inv_ship_priority": "3",
"inv_AutoRefund": "0",
"inv_eweb_credit_available": "0.00",
"inv_eweb_apply_credit_amount": "0.00",
"inv_total": "0.00",
"inv_amount": "0.00",
"inv_balance": "0.00",
"inv_payment_to_apply_distributed": "0.00",
"inv_close_opportunity": "0",
"inv_credit_to_apply_distributed": "0.00",
"inv_distributable_credit_total": "0.00",
"inv_distributable_credit_balance": "0.00",
"inv_paid_by_liability_balance": "0.00",
"inv_nettotal": "0.00",
"inv_netpayment": "0.00",
"inv_credit_to_apply": "0.00",
"inv_netbalance": "0.00",
"inv_netcredit": "0.00",
"inv_netunpaidbalance": "0.00",
"inv_netwriteoff": "0.00",
"inv_writeoff_to_apply": "0.00",
"inv_netreturn": "0.00",
"inv_return_to_apply": "0.00",
"inv_netapplied": "0.00",
"inv_previous_netapplied": "0.00",
"inv_previous_netpayment": "0.00",
"inv_total_to_apply": "0.00",
"inv_allow_payment_with_frozen_payment_method": "0",
"inv_select_all": "0",
"inv_details_html": "<table cellspacing=1 cellpadding=1><tr><td></td></tr></table>",
"inv_autoapply": "0",
"inv_autoapplypayment": "0",
"inv_installment_flag": "0",
"inv_coe_flag": "0",
"inv_shippable_total": "0.00",
"inv_unapplied_shipping_total": "0.00",
"inv_shippable_items_flag": "0",
"inv_autoapplycredit": "0",
"inv_bill_me": "0",
"inv_HasNewLineItems": "0",
"inv_HasOldLineItems": "0",
"inv_total_weight": "0.00",
"inv_discount": "0.00",
"inv_shipping": "0.00",
"inv_tax": "0.00"
},
"Payment": null,
"Payment_Info": {
"pin_hosted_page_available": "0",
"pin_mobile_app_available": "0",
"pin_hosted_payment": "0",
"pin_isvault": "0",
"pin_tax_amt": "0.00",
"pin_billing_info_required_for_ach_flag": "0",
"pin_allow_online_payment_flag": "0",
"pin_preferred_flag": "0"
},
"Payment_Method": null,
"source_code": null,
"Registrant": {
"reg_attendance_flag": "1",
"reg_adr_state": "NULL",
"reg_adr_country": "UNITED STATES",
"reg_registration_date": "2020-04-28T00:00:00-04:00"
},
"RegistrantCollection": null
}
}
Copy
SAMPLE RESULT: Key not found
HTTP STATUS: 200
DATA: JSON
{
"EventsRegistrantGroupType": {
"CurrentKey": "032e5656-a0cd-4fd9-8f8f-3747d7d64d3e",
"Group_Registration": {
"egp_number_of_registrants": "0"
},
"Organization": {
"org_consortia_flag": "0",
"org_select_flag": "0"
},
"Customer": null,
"Individual_X_Organization": {
"ixo_primary": "0",
"ixo_owner": "0"
},
"Individual": null,
"Address": {
"adr_state": "NULL",
"adr_country": "UNITED STATES"
},
"Address_XRef": {
"cxa_primary": "0",
"cxa_owner": "0",
"cxa_billing": "0",
"cxa_create_change_log": "0"
},
"Email": {
"eml_type": "business",
"eml_primary": "0"
},
"Website": {
"url_type": "internet",
"url_primary": "0"
},
"Messaging": {
"msg_primary": "0"
},
"Phone": {
"phn_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Phone_XRef": {
"cph_pht_key": "88ff5661-2d14-4bdf-be4c-906c3bff7ef7",
"cph_primary": "0",
"cph_owner": "0"
},
"Fax": {
"fax_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Fax_XRef": {
"cfx_fxt_key": "6b632577-c4ef-42ac-ae19-6dfe0ddece4b",
"cfx_primary": "0",
"cfx_owner": "0"
},
"Event": {
"evt_tzn_key": "059930c3-7d4e-46d9-8a59-e3c95a2a19cd",
"evt_charity_event_flag": "0",
"evt_registered": "0",
"evt_onwaitlist": "0",
"evt_Registered_main_count": "0",
"evt_waitList_main_count": "0",
"evt_Registered_guest_count": "0",
"evt_waitList_guest_count": "0",
"evt_payables_batch_suffix": "BATCH"
},
"Event_Location_Room_Type": null,
"Room_Request": null,
"Invoice": {
"inv_print_count": "0",
"inv_ship_priority": "3",
"inv_AutoRefund": "0",
"inv_eweb_credit_available": "0.00",
"inv_eweb_apply_credit_amount": "0.00",
"inv_total": "0.00",
"inv_amount": "0.00",
"inv_balance": "0.00",
"inv_payment_to_apply_distributed": "0.00",
"inv_close_opportunity": "0",
"inv_credit_to_apply_distributed": "0.00",
"inv_distributable_credit_total": "0.00",
"inv_distributable_credit_balance": "0.00",
"inv_paid_by_liability_balance": "0.00",
"inv_nettotal": "0.00",
"inv_netpayment": "0.00",
"inv_credit_to_apply": "0.00",
"inv_netbalance": "0.00",
"inv_netcredit": "0.00",
"inv_netunpaidbalance": "0.00",
"inv_netwriteoff": "0.00",
"inv_writeoff_to_apply": "0.00",
"inv_netreturn": "0.00",
"inv_return_to_apply": "0.00",
"inv_netapplied": "0.00",
"inv_previous_netapplied": "0.00",
"inv_previous_netpayment": "0.00",
"inv_total_to_apply": "0.00",
"inv_allow_payment_with_frozen_payment_method": "0",
"inv_select_all": "0",
"inv_details_html": "<table cellspacing=1 cellpadding=1><tr><td></td></tr></table>",
"inv_autoapply": "0",
"inv_autoapplypayment": "0",
"inv_installment_flag": "0",
"inv_coe_flag": "0",
"inv_shippable_total": "0.00",
"inv_unapplied_shipping_total": "0.00",
"inv_shippable_items_flag": "0",
"inv_autoapplycredit": "0",
"inv_bill_me": "0",
"inv_HasNewLineItems": "0",
"inv_HasOldLineItems": "0",
"inv_total_weight": "0.00",
"inv_discount": "0.00",
"inv_shipping": "0.00",
"inv_tax": "0.00"
},
"Payment": null,
"Payment_Info": {
"pin_hosted_page_available": "0",
"pin_mobile_app_available": "0",
"pin_hosted_payment": "0",
"pin_isvault": "0",
"pin_tax_amt": "0.00",
"pin_billing_info_required_for_ach_flag": "0",
"pin_allow_online_payment_flag": "0",
"pin_preferred_flag": "0"
},
"Payment_Method": null,
"source_code": null,
"Registrant": {
"reg_attendance_flag": "1",
"reg_adr_state": "NULL",
"reg_adr_country": "UNITED STATES",
"reg_registration_date": "2020-04-28T00:00:00-04:00"
},
"RegistrantCollection": null
}
}