# Returns a list of records with the specified exam_id

Returns a list of records with the specified exam_id

Endpoint: GET /examOfferings/{tenantId}/portal/{contact_id}/describeForExam/{exam_id}
Version: v1-2025-04-18
Security: knox-authorizer

## Path parameters:

  - `tenantId` (string, required)
    The tenant

  - `contact_id` (string, required)
    The contact_id to use to for record lookup

  - `exam_id` (string, required)
    The exam_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

## Response 200 fields (application/json):

  - `Count` (integer)

  - `Items` (array)

  - `Items.additional_location_info` (string)
    Additional location information

  - `Items.address` (object)
    A complete address

  - `Items.address.city` (string)
    The city of the address

  - `Items.address.country` (string)
    The country ISO code
    Enum: "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"

  - `Items.address.country_name` (string)
    The full name of hte country

  - `Items.address.county` (string)
    The county

  - `Items.address.latitude` (number)

  - `Items.address.line1` (string)
    The first line of the address

  - `Items.address.line2` (string)
    The second line of the address

  - `Items.address.line3` (string)
    The third line of the address

  - `Items.address.longitude` (number)

  - `Items.address.postal_code` (string)
    The zip/postal code

  - `Items.address.state` (string)
    The state/province of the address

  - `Items.address.time_zone_id` (string)

  - `Items.course_offering_id` (string)
    The course offering tied to this exam

  - `Items.date` (string, required)
    The date/time of the exam

  - `Items.description` (string)
    A description for the portal

  - `Items.eligibility_requirements` (object, required)
    The criteria to use

  - `Items.eligibility_requirements.advanced_rule_error_message` (string)
    The error message to show when the advanced rule fails

  - `Items.eligibility_requirements.advanced_rules` (object)

  - `Items.eligibility_requirements.age_restrictions` (object)

  - `Items.eligibility_requirements.age_restrictions.maximum_age` (number)
    The maximum age of the contact

  - `Items.eligibility_requirements.age_restrictions.minimum_age` (number)
    The minimum age of the contact

  - `Items.eligibility_requirements.award_options` (object)

  - `Items.eligibility_requirements.award_options.award_ids` (array)

  - `Items.eligibility_requirements.award_options.award_type_ids` (array)

  - `Items.eligibility_requirements.award_options.logic_operator` (string)
    Enum: "and", "not"

  - `Items.eligibility_requirements.award_recipients` (boolean)
    If set, only people who have received awards

  - `Items.eligibility_requirements.by_location` (boolean)
    If true, then filter by location

  - `Items.eligibility_requirements.certificants` (boolean)
    If set, only people with specific certifications

  - `Items.eligibility_requirements.certification_options` (object)

  - `Items.eligibility_requirements.certification_options.program_ids` (array)

  - `Items.eligibility_requirements.committee_member_options` (object)

  - `Items.eligibility_requirements.committee_member_options.committee_ids` (array)

  - `Items.eligibility_requirements.committee_member_options.committee_position_ids` (array)

  - `Items.eligibility_requirements.committee_member_options.committee_type_ids` (array)

  - `Items.eligibility_requirements.committee_members` (boolean)
    If set, active members who belong to a committee can purchase

  - `Items.eligibility_requirements.custom_logic_options` (object)

  - `Items.eligibility_requirements.custom_logic_options.lambda_function_id` (string, required)
    The custom lambda function to use

  - `Items.eligibility_requirements.customer_type` (string)
    Enum: "contact", "organization"

  - `Items.eligibility_requirements.donor_options` (object)

  - `Items.eligibility_requirements.donor_options.donor_club_ids` (array)

  - `Items.eligibility_requirements.donors` (boolean)
    If true, only donors

  - `Items.eligibility_requirements.enable_advanced_rules` (boolean)
    Enable advanced JSON rules

  - `Items.eligibility_requirements.enable_age_restrictions` (boolean)
    Age registrations

  - `Items.eligibility_requirements.enable_custom_logic` (boolean)
    If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

  - `Items.eligibility_requirements.enable_entitlement_restrictions` (boolean)
    If set, then you must have certain entitlements

  - `Items.eligibility_requirements.enable_expression` (boolean)
    Whether or not to enable an expression for evaluation

  - `Items.eligibility_requirements.enable_organization_restrictions` (boolean)
    If set, you can restrict organizations

  - `Items.eligibility_requirements.enable_status_restriction` (boolean)
    If set, you can restrict by status

  - `Items.eligibility_requirements.entitlement_restrictions` (array)

  - `Items.eligibility_requirements.entitlement_restrictions.quantity` (number)
    The quantity you must have

  - `Items.eligibility_requirements.entitlement_restrictions.type_id` (string, required)
    The type of entitlement

  - `Items.eligibility_requirements.event_registration_options` (object)

  - `Items.eligibility_requirements.event_registration_options.event_ids` (array)

  - `Items.eligibility_requirements.event_registration_options.registration_category_ids` (array)

  - `Items.eligibility_requirements.event_registrations` (boolean)
    If set, only people who have registered for events

  - `Items.eligibility_requirements.expression` (string)
    The expression

  - `Items.eligibility_requirements.expression_error_message` (string)
    The error message to show when the expression fails

  - `Items.eligibility_requirements.location` (object)

  - `Items.eligibility_requirements.location.countries` (array)
    Countries

  - `Items.eligibility_requirements.location.negate_logic` (boolean)
    If true, the logic in this section is negated; so NOT from these places

  - `Items.eligibility_requirements.member_options` (object)

  - `Items.eligibility_requirements.member_options.chapter_member_options` (object)

  - `Items.eligibility_requirements.member_options.chapter_member_options.chapter_ids` (array)

  - `Items.eligibility_requirements.member_options.chapter_member_options.chapter_type_ids` (array)

  - `Items.eligibility_requirements.member_options.chapter_members` (boolean)
    If set, active members who belong to a chapter can purchase

  - `Items.eligibility_requirements.member_options.member_package_ids` (array)
    The member package

  - `Items.eligibility_requirements.member_options.member_status_reason_ids` (array)

  - `Items.eligibility_requirements.member_options.member_statuses` (array)
    Enum: "active", "inactive", "suspended"

  - `Items.eligibility_requirements.member_options.member_type_ids` (array)
    The member types

  - `Items.eligibility_requirements.member_options.section_member_options` (object)

  - `Items.eligibility_requirements.member_options.section_member_options.section_ids` (array)

  - `Items.eligibility_requirements.member_options.section_member_options.section_type_ids` (array)

  - `Items.eligibility_requirements.member_options.section_members` (boolean)
    If set, active members who belong to a section can purchase

  - `Items.eligibility_requirements.members` (boolean)
    If set, active members can purchase this

  - `Items.eligibility_requirements.non_members` (boolean)
    If set, only nonmembers can purchase

  - `Items.eligibility_requirements.organization_restrictions` (object)

  - `Items.eligibility_requirements.organization_restrictions.contact_role_ids` (array)

  - `Items.eligibility_requirements.organization_restrictions.organization_type_ids` (array)

  - `Items.eligibility_requirements.status_restrictions` (array)
    The statuses

  - `Items.eligibility_requirements.use_organization_for_eligibility` (boolean)
    If checked, a person's organization is used to check for eligibility, rather than the person themselves

  - `Items.enable_eligibility_requirements` (boolean)
    If true, this offering is only available to certain individuals

  - `Items.end_time` (string)
    The registration date/time

  - `Items.exam_id` (string, required)
    The exam

  - `Items.fail_letter_id` (string)
    The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam

  - `Items.fee_id` (string)
    The fee for initial testing

  - `Items.id` (string, required)
    The unique, string identifier of this exam offering

  - `Items.is_active` (boolean)
    Whether this exam is active and available

  - `Items.name` (string, required)
    The name of the offering

  - `Items.notes` (string)

  - `Items.pass_letter_id` (string)
    The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam

  - `Items.registration_time` (string)
    The registration date/time

  - `Items.retest_fee_id` (string)
    The fee for retake/retest

  - `Items.start_time` (string)
    The registration date/time

  - `Items.sys_bulk_load_at` (string)
    If this record was loaded via bulk, the timestamp when the record was processed

  - `Items.sys_bulk_load_id` (string)
    If this record was loaded via bulk, the ID of the bulk load process

  - `Items.sys_bulk_load_pk` (string)
    If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

  - `Items.sys_bulk_load_record_no` (number)
    If this record was loaded via bulk, the record number in the source file

  - `Items.sys_bulk_load_source_file` (string)
    If this record was loaded via bulk, the source file

  - `Items.sys_calculated_field_error` (string)
    The error associated with the calculated field

  - `Items.sys_calculated_field_errors` (array)

  - `Items.sys_calculated_field_errors.error` (string)

  - `Items.sys_calculated_field_errors.field` (string)

  - `Items.sys_configuration_snapshot_id` (string)
    If a snapshot was restored/applies to this record, the ID of the snapshot

  - `Items.sys_created_at` (string, required)
    The date/time that this record was created, expressed in ISO-8601 date format

  - `Items.sys_created_by_id` (string, required)
    The ID of the user that created this record

  - `Items.sys_deleted_by_id` (string)
    The ID of the user that deleted (or last tried to delete) this object

  - `Items.sys_directive` (string)
    Means for passing directive information into an object processing logic

  - `Items.sys_external_id` (string)
    The ID that a record has from an external system or data import

  - `Items.sys_has_files_in_s3` (boolean)
    If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

  - `Items.sys_last_bulk_data_operation_id` (string)
    If this record was last touched by a bulk data operation, the ID of that operation

  - `Items.sys_last_bulk_data_operation_sys_version` (string)
    If this record was last touched by a bulk data operation, the sys_version at the time of that operation

  - `Items.sys_last_modified_at` (string, required)
    The date/time that this record record was last modified, expressed in ISO-8601 date format

  - `Items.sys_last_modified_by_id` (string, required)
    The ID of the user that last modified this record

  - `Items.sys_last_security_context` (object)
    The security context of the last insert, modify, or delete performed on this item

  - `Items.sys_locked` (boolean)
    If set, this record is locked and cannot be changed via the API

  - `Items.sys_snapshot_base_version` (number)
    The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

  - `Items.sys_version` (number)
    A number representing the version of this record in the database

  - `Items.testing_facility_id` (string, required)
    The exam testing site

  - `Items.training_location_id` (string, required)
    The training facility

  - `Items.type` (string, required)
    The type of exam
    Enum: "live", "remote proctor"

  - `LastEvaluatedKey` (string)


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields