Skip to content
Events
/
/
Returns a registration se...

Returns a registration setting from the system by its ID.

Request

This method will look up a registration setting by the specified ID and return it back.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the registration setting to return.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationSettings/{tenantId}/{id}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The registration setting was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

bill_my_organization_optionsobject(Bill My Organization Options)
bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_deadlinestring, (date-time)(Cancellation Deadline)required
cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

cancellation_policystring(Cancellation Policy)
Enum:"none""relative date""specific date"
cancellation_relative_dateobject(Cancellation Relative Date)required
certificate_modestring(Certificate Mode)
Enum:"automatically generate""create manually""disabled"
certificate_templatestring(Certificate Template)required
certification_credit_optionsobject(Certification Credit Options)required
checkout_donation_optionsobject(Checkout Donation Options)required
course_registration_settingsobject(Course Registration Settings)required
credit_card_minimum_range_endnumber, (float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

credit_card_minimum_range_startnumber, (float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum:"disabled""enabled""range"
credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum:"charge""do not charge""prompt user"
credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required
custom_order_preprocessing_optionsobject(Custom Order Preprocessing Options)required
custom_order_pricing_optionsobject(Custom Order Pricing Options)required
default_registration_process_idstring(Default Registration Process)

The default registration process, which can be used for registrations that have no process (such as imported registrations)

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

enable_certification_creditsboolean(Enable Certification Credits)

If true, then this event will generate certification credits

enable_course_registrationboolean(Enable Course Registration)

If true, registrants can access certification

enable_custom_order_preprocessingboolean(Enable Custom Order Preprocessing)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

enable_custom_order_pricingboolean(Enable Custom Order Pricing)

If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_group_registrationboolean(Enable Group Registration)

Whether or not group registration is enabled

enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

enable_webinar_integrationboolean(Enable Webinar Integration)

If selecting, registration will be linked to an external webinar service

group_registration_optionsobject(Group Registration Options)required
idstring(ID)^[\w|-]+$required

The unique, string identifier of this registration setting

installment_plan_optionsArray of objects, non-emptyrequired
invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

maximum_number_of_registrants_from_the_same_organizationnumber, (float), >= 1(Maximum Number Of Registrants From The Same Organization)required
membership_renewal_windownumber, (float)(Membership Renewal Window)

When prompting for membership renewal during the event, the number of days during which if the member is expiring, they are prompted to renew

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

notesstring(Notes)

Notes about the settings

pay_later_optionsobject(Pay Later Options)
registration_deadlinesArray of objects, non-emptyrequired

The registration deadline dates

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

restrict_registrants_from_same_organizationboolean(Restrict Registrants From Same Organization)

If checked, then the system will restrict how many people from the same organization can register for this event

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber, (float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring, (date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring, (date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber, (float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

use_registration_deadlinesboolean(Use Registration Deadlines)

Whether or not registration should have deadlines

webinar_integration_optionsobject(Webinar Integration Options)required
Response
{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_deadline": "2019-08-24T14:15:22Z",
  "cancellation_fee_product_id": "string",
  "cancellation_policy": "none",
  "cancellation_relative_date": {
    "number": null,
    "position": "after",
    "relative_to": "the beginning of the month",
    "unit_of_time": "days"
  },
  "certificate_mode": "automatically generate",
  "certificate_template": "string",
  "certification_credit_options": {
    "applicable_registration_type_ids": [ … ],
    "credits": [ … ],
    "mark_as_verified": true,
    "single_quantity_credits": true
  },
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "course_registration_settings": {
    "course_reg_process_id": "string"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "custom_order_preprocessing_options": {
    "lambda_function_id": "string"
  },
  "custom_order_pricing_options": {
    "lambda_function_id": "string"
  },
  "default_registration_process_id": "string",
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_certification_credits": true,
  "enable_course_registration": true,
  "enable_custom_order_preprocessing": true,
  "enable_custom_order_pricing": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_group_registration": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "enable_webinar_integration": true,
  "group_registration_options": {
    "allow_users_to_update_organization": true,
    "close_date": "2019-08-24T14:15:22Z",
    "confirmation_email_recipient": "both",
    "contact_form_html": "string",
    "contact_form_id": "string",
    "contact_role_ids": [ … ],
    "enable_tiered_discounts": true,
    "group_administrator_confirmation_email": { … },
    "open_date": "2019-08-24T14:15:22Z",
    "organization_form_html": "string",
    "organization_form_id": "string",
    "restrict_to_specific_contact_roles": true,
    "send_confirmation_email_to_group_administrator": true,
    "tiered_discount_rules": [ … ]
  },
  "id": "string",
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "maximum_number_of_registrants_from_the_same_organization": 1,
  "membership_renewal_window": 0.1,
  "merchant_account_id": "string",
  "notes": "string",
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "registration_deadlines": [
    { … }
  ],
  "restocking_fee_product_id": "string",
  "restrict_registrants_from_same_organization": true,
  "special_instructions": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "use_pro_forma_invoices": true,
  "use_registration_deadlines": true,
  "webinar_integration_options": {
    "meeting_id": "string",
    "type": "meeting",
    "webinar_account_id": "string",
    "webinar_id": "string",
    "webinar_service": "integrations-zoom-accounts"
  }
}