Error Handling

When the system validates the data during save and submit, if validation errors occur, the error handling feature returns a list of textual descriptions of those errors along with error IDs and the field names related to the errors. As much information as possible is returned to the user interface to present the errors to the user and allow correction of the errors.

The user interface must perform the following steps to use the error handling feature:

• The user interface must populate a unique ID into the tag called SCC_ENTITY_INST_ID in the request xml for each entity. In the event of error during data validation, error handling returns to the user interface the unique ID (that is obtained from the request message) and the field name related to the error along with the error message text.

• The user interface can use this unique error ID, the field name, and the error message to know what fields on what pages are in error. This allows the user interface to highlight the fields with errors and allows the user to correct the data.

The unique ID is optional in the request schema. Therefore, institutions should populate the unique ID only if they want to uptake the error handling feature.

Institutions are free to populate the SCC_ENTITY_INST_ID in any format they please, but it is recommended that they use the official Universally Unique Identifier (UUID) format, 36 character ISO standard.