The Certifications API provides all the capabilities for managing the certification process beginning with your Certification Program. You can also manage Applications, Courses, or Course Offerings from this API.
Like most of the other Rhythm apps, the Certifications API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/settings/{tenantId}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The setting was retrieved successfully.
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used
The default page layout when showing an certification
The default page layout when showing an certification
The default page layout when showing a certification
The default page layout when showing a certification
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, a custom template is used to show the application information in the portal
If selected, users will be prompted to make a donation upon checking out
Whether or not discounts for multiple certifications are enabled
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, training providers can administer in the portal
If set, training provider billing is enabled in the UI
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The way certification programs are browsed in the portal
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The product used when billing training providers for a certification fee
The product used when billing training providers for a course fee
The product used when billing training providers for a live exam fee
The product used when billing training providers for a reinstatement fee
The product used when billing training providers for a remote proctor fee
The product used when billing training providers for a renewal fee
{ "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_fee_product_id": "string", "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "contact_role_permissions": [ { … } ], "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_application_portal_template": "string", "default_application_360_screen_id": "string", "default_application_page_layout_id": "string", "default_certification_360_screen_id": "string", "default_certification_page_layout_id": "string", "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_application_portal_template": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_multiple_certification_discounts": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "enable_training_provider_administration": true, "enable_training_provider_billing": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "multiple_certification_discount_options": { "discount_amount": 0.1, "discount_type": "amount", "ineligible_program_ids": [ … ], "start_after": 0.1 }, "notes": "string", "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "portal_browse_certification_programs_mode": "list", "restocking_fee_product_id": "string", "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, "training_provider_administration_options": { "access_saved_queries": true, "create_contact_form_id": "string", "edit_contact_form_id": "string", "saved_queries": { … } }, "training_provider_billing_options": { "certification_fee_id": "string", "course_fee_id": "string", "live_exam_fee_id": "string", "reinstatement_fee_id": "string", "remote_proctor_exam_fee_id": "string", "renewal_fee_id": "string", "retest_fee_id": "string" }, "use_pro_forma_invoices": true }
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The setting was patched successfully.
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used
The default page layout when showing an certification
The default page layout when showing an certification
The default page layout when showing a certification
The default page layout when showing a certification
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, a custom template is used to show the application information in the portal
If selected, users will be prompted to make a donation upon checking out
Whether or not discounts for multiple certifications are enabled
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, training providers can administer in the portal
If set, training provider billing is enabled in the UI
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The way certification programs are browsed in the portal
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The product used when billing training providers for a certification fee
The product used when billing training providers for a course fee
The product used when billing training providers for a live exam fee
The product used when billing training providers for a reinstatement fee
The product used when billing training providers for a remote proctor fee
The product used when billing training providers for a renewal fee
{ "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_fee_product_id": "string", "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "contact_role_permissions": [ { … } ], "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_application_portal_template": "string", "default_application_360_screen_id": "string", "default_application_page_layout_id": "string", "default_certification_360_screen_id": "string", "default_certification_page_layout_id": "string", "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_application_portal_template": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_multiple_certification_discounts": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "enable_training_provider_administration": true, "enable_training_provider_billing": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "multiple_certification_discount_options": { "discount_amount": 0.1, "discount_type": "amount", "ineligible_program_ids": [ … ], "start_after": 0.1 }, "notes": "string", "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "portal_browse_certification_programs_mode": "list", "restocking_fee_product_id": "string", "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, "training_provider_administration_options": { "access_saved_queries": true, "create_contact_form_id": "string", "edit_contact_form_id": "string", "saved_queries": { … } }, "training_provider_billing_options": { "certification_fee_id": "string", "course_fee_id": "string", "live_exam_fee_id": "string", "reinstatement_fee_id": "string", "remote_proctor_exam_fee_id": "string", "renewal_fee_id": "string", "retest_fee_id": "string" }, "use_pro_forma_invoices": true }
The setting that you would like to be saved.
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used
The default page layout when showing an certification
The default page layout when showing an certification
The default page layout when showing a certification
The default page layout when showing a certification
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, a custom template is used to show the application information in the portal
If selected, users will be prompted to make a donation upon checking out
Whether or not discounts for multiple certifications are enabled
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, training providers can administer in the portal
If set, training provider billing is enabled in the UI
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The way certification programs are browsed in the portal
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The product used when billing training providers for a certification fee
The product used when billing training providers for a course fee
The product used when billing training providers for a live exam fee
The product used when billing training providers for a reinstatement fee
The product used when billing training providers for a remote proctor fee
The product used when billing training providers for a renewal fee
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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_fee_product_id": "string",
"checkout_donation_options": {
"simple_checkout_donation_options": {
"allow_user_to_specify_custom_amount": true,
"donation_ask_text": "string",
"donation_denominations": [
0.1
],
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0.1
},
"type": "simple"
},
"contact_role_permissions": [
{
"apply_for_certification": true,
"renew_certification": true,
"role_id": "string",
"training_provider_administrator": true,
"view_applications": true
}
],
"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_application_portal_template": "string",
"default_application_360_screen_id": "string",
"default_application_page_layout_id": "string",
"default_certification_360_screen_id": "string",
"default_certification_page_layout_id": "string",
"disable_electronic_payment_vaulting": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_custom_application_portal_template": true,
"enable_donations_at_checkout": true,
"enable_electronic_checks": true,
"enable_multiple_certification_discounts": true,
"enable_pay_later": true,
"enable_payroll_deduction": true,
"enable_split_payments": true,
"enable_training_provider_administration": true,
"enable_training_provider_billing": true,
"installment_plan_options": [
{
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
],
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"merchant_account_id": "string",
"multiple_certification_discount_options": {
"discount_amount": 0.1,
"discount_type": "amount",
"ineligible_program_ids": [
"string"
],
"start_after": 0.1
},
"notes": "string",
"pay_later_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"portal_browse_certification_programs_mode": "list",
"restocking_fee_product_id": "string",
"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": [
{
"error": "string",
"field": "string"
}
],
"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,
"training_provider_administration_options": {
"access_saved_queries": true,
"create_contact_form_id": "string",
"edit_contact_form_id": "string",
"saved_queries": {
"0": {
"display_name": "string",
"saved_query_id": "string"
}
}
},
"training_provider_billing_options": {
"certification_fee_id": "string",
"course_fee_id": "string",
"live_exam_fee_id": "string",
"reinstatement_fee_id": "string",
"remote_proctor_exam_fee_id": "string",
"renewal_fee_id": "string",
"retest_fee_id": "string"
},
"use_pro_forma_invoices": true
}'The setting was saved successfully.
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used
The default page layout when showing an certification
The default page layout when showing an certification
The default page layout when showing a certification
The default page layout when showing a certification
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, a custom template is used to show the application information in the portal
If selected, users will be prompted to make a donation upon checking out
Whether or not discounts for multiple certifications are enabled
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, training providers can administer in the portal
If set, training provider billing is enabled in the UI
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The way certification programs are browsed in the portal
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The product used when billing training providers for a certification fee
The product used when billing training providers for a course fee
The product used when billing training providers for a live exam fee
The product used when billing training providers for a reinstatement fee
The product used when billing training providers for a remote proctor fee
The product used when billing training providers for a renewal fee
{ "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_fee_product_id": "string", "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "contact_role_permissions": [ { … } ], "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_application_portal_template": "string", "default_application_360_screen_id": "string", "default_application_page_layout_id": "string", "default_certification_360_screen_id": "string", "default_certification_page_layout_id": "string", "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_application_portal_template": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_multiple_certification_discounts": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "enable_training_provider_administration": true, "enable_training_provider_billing": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "multiple_certification_discount_options": { "discount_amount": 0.1, "discount_type": "amount", "ineligible_program_ids": [ … ], "start_after": 0.1 }, "notes": "string", "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "portal_browse_certification_programs_mode": "list", "restocking_fee_product_id": "string", "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, "training_provider_administration_options": { "access_saved_queries": true, "create_contact_form_id": "string", "edit_contact_form_id": "string", "saved_queries": { … } }, "training_provider_billing_options": { "certification_fee_id": "string", "course_fee_id": "string", "live_exam_fee_id": "string", "reinstatement_fee_id": "string", "remote_proctor_exam_fee_id": "string", "renewal_fee_id": "string", "retest_fee_id": "string" }, "use_pro_forma_invoices": true }
The updated setting that will be saved.
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used
The default page layout when showing an certification
The default page layout when showing an certification
The default page layout when showing a certification
The default page layout when showing a certification
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, a custom template is used to show the application information in the portal
If selected, users will be prompted to make a donation upon checking out
Whether or not discounts for multiple certifications are enabled
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, training providers can administer in the portal
If set, training provider billing is enabled in the UI
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The way certification programs are browsed in the portal
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The product used when billing training providers for a certification fee
The product used when billing training providers for a course fee
The product used when billing training providers for a live exam fee
The product used when billing training providers for a reinstatement fee
The product used when billing training providers for a remote proctor fee
The product used when billing training providers for a renewal fee
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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_fee_product_id": "string",
"checkout_donation_options": {
"simple_checkout_donation_options": {
"allow_user_to_specify_custom_amount": true,
"donation_ask_text": "string",
"donation_denominations": [
0.1
],
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0.1
},
"type": "simple"
},
"contact_role_permissions": [
{
"apply_for_certification": true,
"renew_certification": true,
"role_id": "string",
"training_provider_administrator": true,
"view_applications": true
}
],
"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_application_portal_template": "string",
"default_application_360_screen_id": "string",
"default_application_page_layout_id": "string",
"default_certification_360_screen_id": "string",
"default_certification_page_layout_id": "string",
"disable_electronic_payment_vaulting": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_custom_application_portal_template": true,
"enable_donations_at_checkout": true,
"enable_electronic_checks": true,
"enable_multiple_certification_discounts": true,
"enable_pay_later": true,
"enable_payroll_deduction": true,
"enable_split_payments": true,
"enable_training_provider_administration": true,
"enable_training_provider_billing": true,
"installment_plan_options": [
{
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
],
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"merchant_account_id": "string",
"multiple_certification_discount_options": {
"discount_amount": 0.1,
"discount_type": "amount",
"ineligible_program_ids": [
"string"
],
"start_after": 0.1
},
"notes": "string",
"pay_later_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"portal_browse_certification_programs_mode": "list",
"restocking_fee_product_id": "string",
"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": [
{
"error": "string",
"field": "string"
}
],
"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,
"training_provider_administration_options": {
"access_saved_queries": true,
"create_contact_form_id": "string",
"edit_contact_form_id": "string",
"saved_queries": {
"0": {
"display_name": "string",
"saved_query_id": "string"
}
}
},
"training_provider_billing_options": {
"certification_fee_id": "string",
"course_fee_id": "string",
"live_exam_fee_id": "string",
"reinstatement_fee_id": "string",
"remote_proctor_exam_fee_id": "string",
"renewal_fee_id": "string",
"retest_fee_id": "string"
},
"use_pro_forma_invoices": true
}'The setting was updated successfully.
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used
The default page layout when showing an certification
The default page layout when showing an certification
The default page layout when showing a certification
The default page layout when showing a certification
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, a custom template is used to show the application information in the portal
If selected, users will be prompted to make a donation upon checking out
Whether or not discounts for multiple certifications are enabled
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, training providers can administer in the portal
If set, training provider billing is enabled in the UI
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The way certification programs are browsed in the portal
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The product used when billing training providers for a certification fee
The product used when billing training providers for a course fee
The product used when billing training providers for a live exam fee
The product used when billing training providers for a reinstatement fee
The product used when billing training providers for a remote proctor fee
The product used when billing training providers for a renewal fee
{ "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_fee_product_id": "string", "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "contact_role_permissions": [ { … } ], "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_application_portal_template": "string", "default_application_360_screen_id": "string", "default_application_page_layout_id": "string", "default_certification_360_screen_id": "string", "default_certification_page_layout_id": "string", "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_application_portal_template": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_multiple_certification_discounts": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "enable_training_provider_administration": true, "enable_training_provider_billing": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "multiple_certification_discount_options": { "discount_amount": 0.1, "discount_type": "amount", "ineligible_program_ids": [ … ], "start_after": 0.1 }, "notes": "string", "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "portal_browse_certification_programs_mode": "list", "restocking_fee_product_id": "string", "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, "training_provider_administration_options": { "access_saved_queries": true, "create_contact_form_id": "string", "edit_contact_form_id": "string", "saved_queries": { … } }, "training_provider_billing_options": { "certification_fee_id": "string", "course_fee_id": "string", "live_exam_fee_id": "string", "reinstatement_fee_id": "string", "remote_proctor_exam_fee_id": "string", "renewal_fee_id": "string", "retest_fee_id": "string" }, "use_pro_forma_invoices": true }