Skip to content

API error codes and messages

Pablo Pazos edited this page Jun 2, 2016 · 16 revisions
Action Error Code Message HTTP Status
/login no record for provided username 401 Unauthorized
/login user disabled 401 Unauthorized
/login user account expired 401 Unauthorized
/login user account locked 401 Unauthorized
/login provided password don't match 401 Unauthorized
/login no organization number provided 401 Unauthorized
/login organization with number provided doesn't exists 401 Unauthorized
/login organization not associated with user 401 Unauthorized
/commit ehrUid not provided 400 Bad Request
/commit auditSystemId not provided 400 Bad Request
/commit auditCommitter not provided 400 Bad Request
/commit no EHR found for the provided ehrUid 400 Bad Request
/commit user can't access the EHR, it belongs to an organization not associated with the user 400 Bad Request
/commit request body is empty or versions XML element not found 400 Bad Request
/commit parsed versions is empty (error during parsing) 400 Bad Request
/commit parsed versions root node is empty (error accessing the root version element) 400 Bad Request
/commit some parsed versions fail XSD validation 400 Bad Request
/commit other generic error related to processing the parsed versions/compositions 400 Bad Request
/checkout ehrUid not provided 400 Bad Request
/checkout compositionUid not provided 400 Bad Request
/checkout user can't access the EHR that contains the composition, because it belongs to an organization not associated with the user 401 Unauthorized (TODO)
/checkout no versions found for the compositionUid 404 Not Found
/checkout the requested composition is not the latest version 400 Bad Request
/checkout the requested composition is not the latest version 500 Internal Server Error
/ehrs requested output format is not supported 400 Bad Request
/ehrs/subjectUid/$subjectUid subjectUid not provided 400 Bad Request
/ehrs/subjectUid/$subjectUid patient doesn't exists 404 Not Found
/ehrs/subjectUid/$subjectUid user can't access the patient, because it belongs to an organization not associated with the user 401 Unauthorized
/ehrs/subjectUid/$subjectUid the patient doesn't have an EHR 404 Not Found
/ehrs/subjectUid/$subjectUid requested output format is not supported 400 Bad Request
/ehrs/ehrUid/$ehrUid ehrUid not provided 400 Bad Request
/ehrs/ehrUid/$ehrUid the EHR doesn't exists 404 Not Found
/ehrs/ehrUid/$ehrUid user can't access the EHR, because it belongs to an organization not associated with the user 401 Unauthorized
/ehrs/ehrUid/$ehrUid requested output format is not supported 400 Bad Request
/patients requested output format is not supported 400 Bad Request
/patients/$uid uid not provided 400 Bad Request
/patients/$uid patient not found 404 Not Found
/patients/$uid requested output format is not supported 400 Bad Request
/queries/$queryUid queryUid not provided 400 Bad Request
/queries/$queryUid query not found 404 Not Found
/queries/$queryUid requested output format is not supported 400 Bad Request
/queries requested output format is not supported 400 Bad Request
/queries/$queryUid/execute queryUid not provided 400 Bad Request
/queries/$queryUid/execute organizationUid not provided 400 Bad Request (To Be Changed)
/queries/$queryUid/execute ehrUid provided but an EHR doesn't exists for it 404 Not Found
/queries/$queryUid/execute the user doesn't have permissions to query the EHR 401 Unauthorized
/queries/$queryUid/execute query doesn't exists for the given queryUid 404 Not Found
/queries/$queryUid/execute frontDate or toDate given but have the wrong format 400 Bad Request (TODO)
/queries/$queryUid/execute given group not supported 400 Bad Request (TODO) https://github.com/ppazos/cabolabs-ehrserver/issues/355
/queries/$queryUid/execute query doesn't exists for the given queryUid 404 Not Found
/queries/$queryUid/execute requested output format is not supported 400 Bad Request (TODO)