ERROR CODES
ERROR CODES are used to set the description of different errors returned by the web services.
Property | Value | Comments |
---|---|---|
#CODE:ID_STANDARD_CODE | "#ERROR" | Constant value to identify ERROR codes |
#CODE:ID_CODE | E.g. SUBSCRIPTION.ACCESS_DENIED | It will correspond to the OBJECT:Property. View next ID_CODE list section |
#CODE:ID_LANGUAGE | "EN","ES","CA","ZH" | Available languages. |
#CODE:CODE_DESCRIPTION | Description of ID_CODE (e.g. "Team Name") | Text that describes the program code identified with the #CODE:ID_CODE |
CODES
ID_CODE | CODE_DESCRIPTION |
---|---|
ACCOUNT.ACTIVATION_PENDING | The account is pending of activation |
ACCOUNT.ALREADY_ACTIVE | The account has already been activated |
ACCOUNT.INVALID_CODE | Invalid activation code |
ACCOUNT.INVALID_EMAIL | Invalid email address |
ACCOUNT.INVALID_PHONE | Invalid phone number |
ACCOUNT.NOT_AVAILABLE | The given account is not available |
ADMISSION.EXIST_ACTIVE | An active admission already exists for the PROGRAM and TEAM: {{REPLACE}} |
ADMISSION.INSERT_ERROR | An error ocurred when creating the ADMISSION |
ADMISSION.NOT_FOUND | The admission was not found |
ADMISSION.NOT_OPEN | The admission is not in a open state |
ADMISSION.REQUIRED_FOR_EVENT | This EVENT requires an ADMISSION |
ADMISSION.STATUS.NOT_ENROLL | The Admission is not in Enroll stage |
AGE_CANNOT_BE_NULL | Age cannot be empty |
ALREADY_ASSOCIATED | It is already associated |
API.INVALID_VERSION | The API Version is not supported by this instance |
ASSOCIATE.NOT_FOUND | The associate does not exist |
ASSOCIATE.NOT_REQUESTED | No request pending to be accepted/rejected |
BIRTHDATE_CANNOT_BE_NULL | Birth Date cannot be empty |
CALL_ASSOCIATE_INSERT_FIRST | The associate does not exist |
CALL_USER_INSERT_FIRST | The user doesn't exist. Previously you need to call user_insert |
CANNOT_INSERT_MANEUVER | Impossible to insert new maneuver |
CANT_BE_NULL | can't be null |
CASE.NOT_FOUND | The patient doesn't exist |
CODE.INVALID_VALUE | The code provided is not valid in {{REPLACE}} codification |
CONTACT_DATA.INVALID_PHONE_PREFFIX | A valid country preffix is required |
CONTACT_DATA.VALIDATION | Contact data has errors |
CONTACT_FIELD.CANT_BE_NULL | Is a mandatory field |
CONTACT_FIELD.DUPLICATE_VALUE | The value provided already exists |
CONTACT_FIELD.INVALID_VALUE | Is not a valid value |
CONTACT_FIELD.MAX_LENGTH | Maximum length: {{REPLACE}} characters |
CONTACT_FIELD.ONLY_NUMBERS | Must be a numeric value |
DESCRIPTION.NOT_FOUND | Description not found |
DESCRIPTION.TRANSLATION_FAILED | Translation service returned an error |
DESCRIPTION.TRANSLATIONS_DISABLED | Translation service is disabled |
DEVICE_TYPE_UNSUPPORTED | Device type is not supported |
EMPTY_PARAMS | Passed parameters are empty |
EVENT.ADMISSION_CONFLICT | There exists a conflict with the admission assigned to the event and some dependency |
EVENT.CLOSED | The event is closed |
EVENT.COMMENT_ORDER_MANDATORY | It is mandatory to indicate the order of the comments |
EVENT.INVALID_TYPE | The value provided for the EVENT type is not valid |
EVENT_NO_CASE | Event without any patient can't be assigned to or posted by patient |
EVENT.NOT_FOUND | Event doesn't exist in database |
EVENT.PROGRAM_CONFLICT | There is a conflict between the PROGRAM and the ADMISSION of the EVENT |
EXISTANT_IDENTIFIER | Can't save identifier because it's already exist |
EXTRACTION_TEMPLATE_WRONG | Extraction template is wrong |
FILL_ALL_FIELDS | Fill all required fields |
FORM.FORM_CODE_FORMAT | FORM CODE must a non numeric value composed by alphanumeric characters and any of the symbols #.:_- (character # cannot be used at the beginning of the FORM CODE) |
FORM.HAS_CLOSED_DEPENDENCIES | The form has closed dependencies and cannot be deleted or opened |
FORM.NOT_FOUND | Form doesn't exist in database |
FORMULA.INVALID_EXPRESSION | The expression is not a valid formula |
GENDER_CANNOT_BE_NULL | Gender cannot be empty |
GRAPH.INVALID_FORMAT | The format JSON specified for the graph is not valid |
HIS.COMM_ERROR | Communication with HIS failed |
HIS.CONFIGURATION | HIS connection is not configured correctly |
HIS.ERROR | HIS returned an error message |
HIS.HIS_NOT_AVAILABLE | The connection to the HIS is not available |
HIS.INVALID_DATA_FORMAT | The HIS connection returned an invalid data format |
IDENTIFIER.ALREADY_EXISTS | The identifier already exists |
IDENTIFIER.CONTACT_NOT_SET | The identifier must be assigned to a contact |
IDENTIFIER.INVALID_LABEL | The label assigned to the identifier is not valid or is empty |
IDENTIFIER.INVALID_VALUE | The value assigned has an invalid format |
IDENTIFIER.TEAM_REQUIRED | The identifier requires a valid TEAM |
IMPORT.APIVERSION_INCOMPATIBLE | Export file was generated by API version higher than the current |
IMPORT.SRCREF_INCOMPATIBLE | The source reference of the object being imported is incompatible |
IMPORT.SRCREF_MISSING | The source reference of the object is missing |
IMPORT.VERSION_UNSUPPORTED | Export file version unsupported |
INSUFFICIENT_PRIVILEGES | Insufficient privileges |
INVALID_ASSOCIATE | Associate is not valid |
INVALID_DATE | Invalid Date introduced |
INVALID_FILTER | Invalid filter |
INVALID_JSON | Bad JSON string format |
INVALID_TOKEN | Invalid Token |
ITEM_TEMPLATE.NOT_FOUND | The template for an ITEM TYPE was not found |
LESS_THAN_3_CHARS | Less than 3 chars were entered! |
LIBRARY_RESOURCE.BASE64ENCODING_EXPECTED | The contents of the resource is expected to be Base64 encoded |
LIBRARY_RESOURCE.HAS_DEPENDENCIES | The Library Resource cannot be deleted because it has dependencies |
LIBRARY_RESOURCE.NOT_FOUND | The Library Resource does not exist |
LIBRARY_RESOURCE.TOO_LARGE | The resource requested is too large |
MEMBERSHIP.HAS_DEPENDENCIES | This team member has dependencies and cannot be deleted |
MEMBERSHIP.NOT_FOUND | The values specified for User, Team and Role do not correspond to a valid membership |
NO_ASSOCIATE_FOUND | There is no associate found |
NO_CASE_FOUND | There is no case found |
NO_EXTRACTION_TEMPLATE | No extraction template defined for the task |
NO_PERSON_FOUND | There is no person associated with patient |
NOT_IMPLEMENTED | Function not implemented |
OBJECT.HOOK_ALREADY_EXISTS | A hook to this object with the same name already exists |
OBJECT_NOT_FOUND | Object not found |
OBJECT.PARENT_DELETED | The parent of this object is deleted |
OPERATION.NOT_ALLOWED | The operation requested is not allowed |
PASSWORD.EXPIRED | The password has expired. It is necessary to change it |
PASSWORD.REQUIREMENT | Requirements for the password: |
PASSWORD.REQUIREMENT.LENGTH | Minimum required length: {{REPLACE}} |
PASSWORD.REQUIREMENT.LOWERCASE | at least one lowercase character |
PASSWORD.REQUIREMENT.NUMBERS | at least one number |
PASSWORD.REQUIREMENT.SPECIAL | at least one special char |
PASSWORD.REQUIREMENT.UPPERCASE | at least one uppercase character |
PASSWORD.RESET_TOKEN.INVALID | The request to change the password is invalid or has expired |
POSTED_BY_ROLE_NOT_INFORMED | Posted by role is not informed |
PROGRAM.DRAFT_EXISTS | There already exists a draft for the program |
PROGRAM.EVENTS_DISABLED | Creation of Events is disabled in the configuration of the Program or Subscription |
PROGRAM.LOCKED | The program is locked |
PROGRAM.NOT_ACTIVE | The Program is not active |
PROGRAM.NOT_FOUND | The Program does not exist |
PROGRAM.NOT_TRIAL | The Program is not configured as Trial |
PROGRAM.SETTINGS.CANNOT_UNSET_TRIAL | It is not possible to remove the "TRIAL" flag because the program contains workplans assigned to an specific trial group (Intervention or Control) |
PROTOCOL.HAS_ADMISSIONS | The protocol contains admissions |
PROTOCOL.NOT_PRESENT | Protocol doesn't exist in database |
QUESTION.INVALID_VALUE | Invalid value |
QUESTION.ITEM_CODE_FORMAT | ITEM_CODE must be composed by a preceding letter and alphanumeric characters or _ (underscore) |
QUESTION.ITEM_CODE_REPEATED | The ITEM_CODE provided already exists in the template |
QUESTION.MAX_EXCEEDED | Maximum value {{REPLACE}} exceeded |
QUESTION.MAX_LENGHT_ERROR | Maximum lenght is {{REPLACE}} characters |
QUESTION.MIN_LENGHT_ERROR | Minimum lenght is {{REPLACE}} characters |
QUESTION.MIN_NOT_REACHED | Value did not reach the {{REPLACE}} minimum |
QUESTION.NOT_ARRAY | The question selected is not of type ARRAY |
QUESTION.NOT_EDITABLE | The question is not editable |
QUESTION.NOT_FOUND | Question not found |
QUESTION.ONLY_FLOAT | Only float type is accepted |
QUESTION.ONLY_NUMBERS | Only numbers are accepted |
QUESTION.WRONG_DATE | Wrong date format |
QUESTION.WRONG_TEXT_FORMAT | The value does not have a valid format |
QUESTION.WRONG_TIME | Wrong time format |
RECORD.NOT_PRESENT | Record doesn't exist in database |
REPORT.NOT_FOUND | The requested Report does not exist in database |
REPORT.REPORT_CODE_FORMAT | REPORT CODE must a non numeric value composed by alphanumeric characters and any of the symbols #.:_- (character # cannot be used at the beginning of the REPORT CODE) |
ROLE.NOT_FOUND | Role does not exist |
SETTINGS.INVALID_VALUE | Invalid value for setting |
SHAREDKEY.INVALID | The invitation is not valid or has expired |
SUBSCRIPTION.ACCESS_DENIED | You are not subscribed to this program for the selected team and role |
SUBSCRIPTION.HAS_ADMISSIONS | The subscription contains admissions |
SUBSCRIPTION.INACTIVE | The program is not active |
SUBSCRIPTION.INVITATION_NOT_FINISHED | Cannot create a new admission because there exists another one with the same invitation reference and the term to create a new one has not passed yet. |
SUBSCRIPTION.NOT_FOUND | Subscription not found |
SUBSCRIPTION.ONLY_EXISTING_PATIENTS_ALLOWED | This program does not allow to create new patients, only existing patients can be used |
SYSTEM.INTERNAL_ERROR | An internal error happened. Contact the system administrator if the problem persists |
TASK.ALREADY_FINISHED | Task is already in finished |
TASK.CANNOT_BE_REMOVED | Impossible to remove task! |
TASK.HAS_CLOSED_DEPENDENCIES | The task has closed dependencies and cannot be deleted or opened |
TASK.LOCKED | The Task is locked and cannot be modified |
TASK.NOT_AVAILABLE | The task you are trying to access is no longer available |
TASK.NOT_FOUND | Task doesn't exist in database |
TASK.NOT_INSERTED | Task was not inserted! |
TASK.TASK_CODE_FORMAT | TASK CODE must a non numeric value composed by alphanumeric characters and any of the symbols #.:_- (character # cannot be used at the beginning of the TASK CODE) |
TEAM.CREATE_FAILED | An error occurred when trying to create the TEAM |
TEAM.HAS_ACTIVE_ADMISSIONS | Team has active admissions |
TEAM.HAS_SUBORDINATED_TEAMS | The team is owner of other teams |
TEAM.HAS_SUBSCRIPTIONS | There exist subscriptions owned by the team |
TEAM.INVALID_CODE | Invalid TEAM CODE. Use only letters, numbers and characters -_#$ |
TEAM.NOT_FOUND | Team not found |
TEAM.TYPE_INCORRECT | Team type is incorrect |
TEMPLATE.NOT_PRESENT | Template doesn't exist in database |
TIMEZONE.INVALID | Invalid date/timezone |
TRASH.OBJECT_NOT_FOUND | Object not found in trash |
UNANSWERED_QUESTIONS | Form has mandatory questions without answer |
USER.ACCESS_DENIED | Invalid user or/and password |
USER.ATTEMPTS_LEFT | Attempts left: {{REPLACE}} |
USER.INSUFFICIENT_ROLES | The user does not have the required roles for the operation |
USER.LOCKED | Your account is locked, try few minutes later |
USER.NOT_FOUND | User doesn't exist in database |
USER.USERNAME_EXISTS | The username is already assigned to another user |
USER.USERNAME_FORMAT | The username value cannot be composed only by numbers nor contain spaces |
VERSION_IS_UP_TO_DATE | Version is up to date! |
WORKPLAN.NOT_FOUND | The Workplan of the task was not found |
WRONG_PARAMS | Some of parameters have wrong format |
XML_ERROR | Error in XML format |