Errors and Error Comments

Detailed mapping of the fields used in POST requests to create responses or comments for errors. This page also provides detailed information on the fields in GET responses for error endpoints.

Set-up

This information is required when implementing to Errors, Error Resolutions or Error Comments via the Ideon API.

• id resources for each request (coverage periods ids, error ids)

• API access

Endpoints

Here are the available errors endpoints:

GET:

• /coverage_periods/{id}/errors

• /errors/{id}

POST:

• /errors/{id}/comments

• /errors/{id}/resolution

These GET endpoints allow you to take a few actions:

1. View and gather the errors associated with a single coverage_period per request sent to GET /coverage_periods/{id}/errors

2. Set up Watcher objects and know when updates to new errors are made available

3. View and assess a single Error with GET /errors/{id}

The POST endpoints enable two ways to interact with Errors that are created by the Ideon team via the enrollment or group setup process:

1. POST a comment to a specific error to aid in clarification of the error

   1. This allows you to build a quick interface in which team members can view, create initial comments, and create new comments in response

2. Change the status of an error to a resolved status by sending POST to /errors/{id}/resolution

   1. This is done after taking specific action or confirming that your data us

Design Questions

The way you use the Task and Task Comments endpoints depends on the needs of your users. Consider using the questions below to evaluate your implementation and how the design fits your user:

What actions must we let the user preform?

• Are they monitoring errors for a connection in a test statem, or one that is in production?

• Are your users commenting on Errors? Resolving them?

What other actions are needed in addition to resolving a Error? - Examples below:

• Can your user request updated information from the Employer Group contact?

• Can your system allow the group contact to enter and send updated information?

• Can your user take note and resolve an error if action is not needed?

• Can your user view comments or add a comment?

• When can your user see pending errors, resolved errors, etc. in each view?

Who will interact with the Errors and Comments?

• What training will they have on the Ideon or other systems?

• What level of security will be required to view the data?

• What level of access is given to each Coverage Period and set of Errors?

What information will be displayed while a user views or interacts with an Error or Error Comment?

• At what level will the user be viewing this information:

  • per member?

  • per coverage period?

  • across many coverage periods per employer?

  • across many groups per broker or other system entity?

What data relationships are important to consider in your system? - Examples below:

• Coverage Periods can have many Errors, an Error can only belong to one coverage period

• Errors can have many comments, comments belong to one Error,

  • These can be viewed per Coverage Period within each Error

• Members can belong to one Group, but can have coverages, errors or be related to many Coverage Periods.

Request Mapping

POST:

• /errors/{id}/comments

• /errors/{id}/resolution

For error comments:

Ideon	Usage & Mapping
message	A stringfield that contains the text of the comment.
created_by	Contains a user field which holds the emailaddress of a user who created this comment. Required format: [e-mail] Must be an email registered as a userwith Ideon.

For error resolutions:

Ideon	Usage & Mapping
message	A string field that holds a message which describes what was done to resolve the error. This is mapped to the resolution_message field on the errors schema

Response Mapping

GET:

• /coverage_periods/{id}/errors

• /errors/{id}

/coverage_periods/{id}/tasks accepts two additional parameters that you can use to filter the response -

• status (query)

  • Filter your response by the resolution status of the errors

  • Available values : unresolved, resolved

  • type - string

• assignee (query)

  • Filter your response by the assigned party of the error

  • Available values : vericred (Ideon) , partner

  • type - string

For all GET endpoints, we respond with the error response schema

Ideon	Definition & Mapping
assignee	This shows which party is responsible for action on the error. This can be either : vericred (Ideon) , or partner
created_at	This is the date on which the error was created.
created_by	This object holds information on the user that created the error. Provided in the response: id - associated with a user email - email address of the user created_at deactivated_at - provided if the current assignee is presently inactive role_names - user roles associated with the email This is an email registered as a userwith Ideon.
comments	Each error comment listed in this object will have: message created_at created_by - which has the id , email, deactivated_at (if applicable) and role_names for a given Ideon user id error_id sent_by
coverage_period_id	This is an id (unique "uuid" format) of the given coverage period.
group_id	This is an id (unique "uuid" format) of the given employer group.
id	This is the id (unique "uuid" format) of this created Error.
discrepancy	This is an object with important information on the specific error: - carrier - this is the information or value in the carrier system platform - this is the information or value provided by yourselves, in the Ideon system parameter - with the options: birth_date, gender, marital_status, earnings_effective_date, employment_start_date, employment_end_date, annual_earnings, wage_frequency, employment_status, residential_address, primary_care_provider, social_security_number, plan_id, plan_start_date, plan_end_date, subscriber, dependent, coverage, plan_volume, tobacco_use, region, emails, phone_numbers
member_id	This is a string field (unique "uuid" format) of the associated member.
message	This is a string field which shows one of these Standard Discrepancy Messages
plan_id	This a string field (unique "uuid" format) of the associated plan.
resolution	This is an object which message, created_at, resolved_by
severity	This field describes the error's impact by categorizing them into: failure, info, warning
status	This field shows the current resolution status of the member: resolved, unresolved, returned
source	This field describes what process or entity produced the error: file_validation, reconciliation, api, manual, error_report
transaction_ids	This is an array of transaction object ids.
census_requests	This is an object which contains information about various census and reconciliation attempts with the carrier. This lists requests associated with this particular error. status , coverage_period_id, id, created_at, errors (a second listing of error messages)

See Additional Documentation for links to our current API documentation.