API Errors

[danfunk]

Attached is a spreadsheet of all the error codes the back end currently produces. We might consider catching the most common and visible error codes and presenting a different message to the user, while retaining the detailed messages for debugging. and development.

[danfunk]

Likely for End User	Location/Context	Code	Message
No	Approval	unknown_approval	Please provide a valid Approval ID.
No	Approval	unknown_approval	The approval [ID] is not recognized.
No	Approval	not_your_approval	You may not modify this approval. It belongs to another user.
No	Approval	invalid_workflow_approval	You can't create an approval for a workflow that has no files to approve in it
No	Files (get)	missing_parameter	Please specify either a workflow_spec_id or a workflow_id with an optional form_field_key
No	Files (add)	invalid_workflow_file	When adding a workflow related file, you must specify a form_field_key
No	Files (add)	invalid_file	You must supply either a workflow spec id or a workflow_id and form_field_key.
No	Files	invalid_file	Expected a file named "file" in the multipart form request
No	Files	invalid_file_type	The file you uploaded has an extension '%s', but it should have an extension of '%s
No	Files	no_such_file	The file id you provided does not exist
No	Files	unknown_file_model	the file model is not recognized
No	Study	missing_pi	Can't create a new study without a Primary Investigator.
No	Study	missing_title	Can't create a new study without a title
No	Study	unknown_study	Please provide a valid Study ID.
No	Study	unknown_study	Please provide a valid Study ID.
No	Study	study_integrity_error	Failed to delete Study #%i due to an Integrity Error: %s"
Yes, Admin only	Tools	undefined_field	Some error information about a missing field when testing a render of markdown or docx.
Yes, Admin only	Tools	invalid_render	Some error information about another error when testing a render of markdown or docx.
No	User	invalid_token	when token expires.
No	User	invalid_sso_credentials	invalid data returned from Shibboleth
Yes	User	token_expired	The Authentication token you provided expired, and must be renewed.
No	User	token_invalid	The Authentication token you provided. You need a new token.
No	Workflow Spec	unknown_spec	Please provide a valid Workflow Specification ID.
No	Workflow Spec	unknown_spec	The Workflow Specification %s is not recognized
Yes	Workflow	invalid_state	You may not move the token to a task who's state is not currently set to COMPLETE or READY
Yes	Workflow	invalid_state	You may not update a task unless it is in the READY state. " "Consider calling a token reset to make this task Ready
No	Workflow	unknown_category	The category is not recognized
Yes	Script Task Errors	missing_argument	Various technical responses details useful during Validation
Yes	Script Task Errors	invalid_argument	Various technical responses about how the arguments are incorrect, attempting to provide informtion during Validation.
No	Script Task Errors	invalid_script	Various technical responses details aimed at new script developers
No	Files	invalid_form_field_key	When uploading files, the form field id must match a known document in the irb_docunents.xslx reference file. This code is not found in that file '%s'" % irb_doc_code)
Yes	Files	unknown_extension	The file you provided does not have an accepted extension: [exe]
Yes	Files	file_not_found	There is no reference file with the name …
No	Workflow	unknown_workflow	Something is wrong. I can't find the workflow you are using.
No	Workflow	file_missing	Can not find a file called '%s' within workflow specification '%s'
Yes, Very	Files	file_integrity_error	You are attempting to delete a file that is required by other records in the system.
Yes	User	missing_ldap_record	Unable to locate a user with id %s in LDAP
No	Workflow Spec	invalid_enum	For enumerations based on an xls file, you must include 3 properties: %s …
No	Workflow Spec	invalid_enum	Unable to locate the lookup data file '%s'"
No	Workflow Spec	invalid_enum	The file %s does not contain a column named %
No	Search	unknown_lookup_option	Lookup supports using spreadsheet options or ldap options, and neither was provided.
Yes	Protocol Builder	invalid_user_id	This user id is invalid: …
Yes	Protocol Builder	protocol_builder_error	Received an invalid response from the protocol builder (status %s
Yes	Protocol Builder	protocol_builder_disabled	The Protocol Builder Service is currently disabled.
No	Script Task Errors	invalid_status	Workflow '%s' can not be set to '%s', should be one of %s"
yes	Script Task Errors	missing_status	No status specified for workflow
No	Workflow Spec	missing_master_spec	No specifications are currently marked as the master spec.
No	Workflow Spec	multiple_master_specs	There is more than one master specification, and I don't know what to do.
yes	Workflow Spec	workflow_startup_exception	Unexpected error when attempting to create a new workflow from the BPMN when starting a study.
yes	Workflow	invalid_script	Error when attempting to run a Task Script that was not implemented in the code correctly
yes	Workflow	unexpected_workflow_structure	Likely caused by a soft-reset, where we fail to deserialize the worklow because it can’t find a task specification.
yes	Workflow	error_running_master_spec	An unexpected error came back when loading the master specification.
No	Workflow	master_spec_not_automatic	The master spec should only contain fully automated tasks, it failed to complete.
No	Workflow Spec	no_primary_bpmn_error	We have somehow lost the connection the primary bpmn file for a workflow.
No	Workflow Spec	workflow_validation_error	Failed to parse Workflow Specification '%s'
No	Workflow Spec	task_error	Raised when running the automated tasks.
No	Workflow	invalid_field	When trying to track down field details for a lookup query, and we fail to find it.
No	Workflow	workflow_validation_exception	A catch all error that occures only during validation.
No	Workflow	unknown_lookup_option	In validation only, when a lookup option can’t be processed correctly.
Yes, Very	Workflow	template_error	Error processing template for task %s: %s