Application Processes

Creates a new application process record that does not already exist.

This method will auto-generate an ID and create a new application process. If an ID is specified for the application process, an error will be thrown.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The application process that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this process
program_id required	string (Program) The program to which this process is tied
name required	string (Name) The name of the process
type	string (Type) Enum: "certification" "renewal" "reinstatement" "transfer"
description	string (Description) A description of the process
customer_type required	string (Customer Type) Enum: "contact" "organization"
fee_id	string (Fee) The baseline fee
expiration_rule_set_id required	string (Expiration Rule Set) The rule set for calculating the expiration of a certification generated by this process
application_expiration_rule_set_id	string (Application Expiration Rule Set) The rule set for calculating the expiration of an application submitted by this process
automatically_approve_applications_once_requirements_are_met	boolean (Automatically Approve Applications Once Requirements Are Met) If true, applications in this process are marked approved once requirements are met. Otherwise they are pending approval
prefill_application_with_profile_information	boolean (Prefill Application With Profile Information) If true, data stored in the certification profile is used as the starting point for the application
enable_eligibility_criteria	boolean (Enable Eligibility Criteria) If true, only certain eligible persons can proceed with this process
required	object (Eligibility Criteria) The criteria to use
enable_grandfather_restrictions	boolean (Enable Grandfather Restrictions) Only people who are grandfathered into other certification programs may complete this process
required	object (Grandfather Restrictions)
display_order	number <float> (Display Order) Optional order to display the process
application_form_id required	string (Application Form) /certifications-applications__.*/ The certification application form
allow_applicants_to_update_in_portal	boolean (Allow Applicants To Update In Portal) Allow for applicants to update the application while it is under review
required	object (Applicant Update Options)
enable_course_registration	boolean (Enable Course Registration) If true, users can register for courses while applying for the certification
required	object (Course Registration Options)
enable_exam_registration	boolean (Enable Exam Registration) If true, users can register for exams while applying for the certification
required	object (Exam Registration Options)
restrict_organization_types	boolean (Restrict Organization Types) Restrict to certain types of organizations
organization_type_ids required	Array of strings (Organization Types) non-empty
required	object (Renewal Options)
	object (Transfer Options)
required	object (Reinstatement Options)
	Array of objects
show_contact_form	boolean (Show Contact Form) Whether or not to show a contact form
required	object (Contact Form Options)
show_organization_form	boolean (Show Organization Form) Whether or not to show an organization form
required	object (Organization Form Options)
display_in_portal	boolean (Display In Portal) Whether or not to hide in the portal
display_in_portal_as	string (Display In Portal As) How to display this process in the portal
is_active	boolean (Is Active) Whether or not this process is active
override_checkout_settings	boolean (Override Checkout Settings) Whether or not to override POC settings
required	object (Checkout Settings)
available_to_training_providers	boolean (Available To Training Providers) If true, this process is available to training providers
enable_application_confirmation_email	boolean (Enable Application Confirmation Email) Whether or not an email should be sent when the application is received
required	object (Application Confirmation Email Options)
enable_certification_activation_email	boolean (Enable Certification Activation Email) Whether or not to send an email when the certification is actually activated
required	object (Certification Activation Email Options)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The application process was saved successfully.

400The application process you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The application process could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add application process based on tenant limits.

500General server error.

post/applicationProcesses/{tenantId}

Request samples

application/json

{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Gets all of the application processes in the system.

This method will scan all application processes and and return them to the caller.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The application processeswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/applicationProcesses/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
]

Returns a application process from the system by its ID.

This method will look up a application process by the specified ID and return it back.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the application process to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The application process was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The application process could not be found.

429Limit exceeded... unable to retrieve application process based on tenant limits.

500General server error.

get/applicationProcesses/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a application process with the specified ID.

This method will update an existing application process with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the application process to update.

Request Body schema: application/json

The updated application process that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this process
program_id required	string (Program) The program to which this process is tied
name required	string (Name) The name of the process
type	string (Type) Enum: "certification" "renewal" "reinstatement" "transfer"
description	string (Description) A description of the process
customer_type required	string (Customer Type) Enum: "contact" "organization"
fee_id	string (Fee) The baseline fee
expiration_rule_set_id required	string (Expiration Rule Set) The rule set for calculating the expiration of a certification generated by this process
application_expiration_rule_set_id	string (Application Expiration Rule Set) The rule set for calculating the expiration of an application submitted by this process
automatically_approve_applications_once_requirements_are_met	boolean (Automatically Approve Applications Once Requirements Are Met) If true, applications in this process are marked approved once requirements are met. Otherwise they are pending approval
prefill_application_with_profile_information	boolean (Prefill Application With Profile Information) If true, data stored in the certification profile is used as the starting point for the application
enable_eligibility_criteria	boolean (Enable Eligibility Criteria) If true, only certain eligible persons can proceed with this process
required	object (Eligibility Criteria) The criteria to use
enable_grandfather_restrictions	boolean (Enable Grandfather Restrictions) Only people who are grandfathered into other certification programs may complete this process
required	object (Grandfather Restrictions)
display_order	number <float> (Display Order) Optional order to display the process
application_form_id required	string (Application Form) /certifications-applications__.*/ The certification application form
allow_applicants_to_update_in_portal	boolean (Allow Applicants To Update In Portal) Allow for applicants to update the application while it is under review
required	object (Applicant Update Options)
enable_course_registration	boolean (Enable Course Registration) If true, users can register for courses while applying for the certification
required	object (Course Registration Options)
enable_exam_registration	boolean (Enable Exam Registration) If true, users can register for exams while applying for the certification
required	object (Exam Registration Options)
restrict_organization_types	boolean (Restrict Organization Types) Restrict to certain types of organizations
organization_type_ids required	Array of strings (Organization Types) non-empty
required	object (Renewal Options)
	object (Transfer Options)
required	object (Reinstatement Options)
	Array of objects
show_contact_form	boolean (Show Contact Form) Whether or not to show a contact form
required	object (Contact Form Options)
show_organization_form	boolean (Show Organization Form) Whether or not to show an organization form
required	object (Organization Form Options)
display_in_portal	boolean (Display In Portal) Whether or not to hide in the portal
display_in_portal_as	string (Display In Portal As) How to display this process in the portal
is_active	boolean (Is Active) Whether or not this process is active
override_checkout_settings	boolean (Override Checkout Settings) Whether or not to override POC settings
required	object (Checkout Settings)
available_to_training_providers	boolean (Available To Training Providers) If true, this process is available to training providers
enable_application_confirmation_email	boolean (Enable Application Confirmation Email) Whether or not an email should be sent when the application is received
required	object (Application Confirmation Email Options)
enable_certification_activation_email	boolean (Enable Certification Activation Email) Whether or not to send an email when the certification is actually activated
required	object (Certification Activation Email Options)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The application process was updated successfully.

400The application process supplied was not valid.

401Unauthorized.

403Forbidden.

404The application process could not be found.

409The application process could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve application process based on tenant limits.

500General server error.

put/applicationProcesses/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a application process with the specified ID.

This method will patch an existing application process with the specified ID, using the HTTP PATCH specification.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the application process to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The application process was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The application process could not be found.

409The application process could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve application process based on tenant limits.

500General server error.

patch/applicationProcesses/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a application process from the system by its ID.

This method will delete a application process with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the application process to delete.

Responses

200The application process was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The application process could not be found.

409The application process could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete application process based on tenant limits.

500General server error.

delete/applicationProcesses/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://certifications.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Gets all of the processes a contact is eligible to use

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
programId required	string The certification program
customerType required	string The contact or organization type Enum: "contact" "organization"
contactOrOrganizationId required	string The contact or organization id

Responses

200Processes were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

get/applicationProcesses/{tenantId}/eligible/{programId}/{customerType}/{contactOrOrganizationId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://certifications.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId/eligible/:programId/:customerType/:contactOrOrganizationId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
]

Returns a list of records with the specified program_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
program_id required	string The program_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/applicationProcesses/{tenantId}/program/{program_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/applicationProcesses/:tenantId/program/:program_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"program_id": "string",
"name": "string",
"type": "certification",
"description": "string",
"customer_type": "contact",
"fee_id": "string",
"expiration_rule_set_id": "string",
"application_expiration_rule_set_id": "string",
"automatically_approve_applications_once_requirements_are_met": true,
"prefill_application_with_profile_information": true,
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"enable_grandfather_restrictions": true,
"grandfather_restrictions": {"certification_program_ids": ["string"
],
"invert_logic": true
},
"display_order": 0,
"application_form_id": "string",
"allow_applicants_to_update_in_portal": true,
"applicant_update_options": {"update_form_id": "string"
},
"enable_course_registration": true,
"course_registration_options": {"course_registration_process_id": "string"
},
"enable_exam_registration": true,
"exam_registration_options": {"exam_registration_process_id": "string"
},
"restrict_organization_types": true,
"organization_type_ids": ["string"
],
"renewal_options": {"renewal_window": 0
},
"transfer_options": {"allowed_program_ids": ["string"
]
},
"reinstatement_options": {"reinstatement_period": 0
},
"requirements": [{"id": "string",
"name": "string",
"type": "credit",
"portal_explanation": "string",
"weight": 0,
"enable_partial_applicability": true,
"partial_applicability_options": {"percentage": 1
},
"credit_requirements": {"credit_type_id": "string",
"type": "fixed",
"number_of_credits": 0,
"formula": "string",
"do_not_allow_reuse": true,
"restrict_certain_activity_types": true,
"restricted_activity_type_ids": ["string"
]
},
"course_requirements": {"course_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"attendance_required": true,
"hide_during_application_process": true
},
"exam_requirements": {"exam_ids": ["string"
],
"time_frame": {"position": "before",
"number": 0,
"unit_of_time": "days",
"relative_to": "the reference date"
},
"hide_during_application_process": true
},
"reference_requirements": {"number_of_references": 1,
"reference_type_id": "string",
"reference_process_id": "string"
},
"field_requirements": {"mapped_field": "string"
},
"expression_requirements": {"expression": "string"
}
}
],
"show_contact_form": true,
"contact_form_options": {"contact_form_id": "string",
"html": "string"
},
"show_organization_form": true,
"organization_form_options": {"organization_form_id": "string",
"html": "string"
},
"display_in_portal": true,
"display_in_portal_as": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"available_to_training_providers": true,
"enable_application_confirmation_email": true,
"application_confirmation_email_options": {"type": "application notice",
"application_notice_id": "string",
"application_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"enable_certification_activation_email": true,
"certification_activation_email_options": {"type": "application notice",
"application_notice_id": "string",
"certification_activation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
}
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The application process could not be found.

429Limit exceeded... unable to retrieve application process based on tenant limits.

500General server error.

post/applicationProcesses/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}