Appearance
Error Definitions ​
All SAM API error responses follow a consistent structure. Below is a comprehensive list of all possible error types.
Error Reference ​
| Error Name | HTTP Code | Error Code | Description |
|---|---|---|---|
WSInternalException | 500 - Internal Server Error | 2000.0 | An internal error has occurred. |
WSUserServiceUnavailableException | 500 - Internal Server Error | 2002.0 | The User Service is currently unavailable! |
WSBrochureServiceUnavailableException | 500 - Internal Server Error | 2011.0 | The Brochure Service is currently unavailable! |
WSCompanyServiceUnavailableException | 500 - Internal Server Error | 2021.0 | The Company Service is currently unavailable! |
WSNoUsernameOrPasswordException | 400 - Bad Request | 1001.0 | Username and Password must be supplied for login. |
WSInsufficientPermissionsException | 401 - Unauthorised | 1003.0 | User does not have permissions for this operation. |
WSAccountLockedException | 401 - Unauthorised | 1004.0 | This account is currently locked. Please check with your Administrator. |
WSAuthenticationFailedException | 401 - Unauthorised | 1005.0 | Failed to authenticate. Please correct login details or press cancel if not registered. |
WSUserServiceException | 500 - Internal Server Error | 2001.0 | An unexpected error occured in the User Service. |
WSCompanyServiceException | 500 - Internal Server Error | 2020.0 | An unexpected error occured in the Company Service. |
WSInvalidAuthTokenException | 401 - Unauthorised | 1006.0 | Invalid or expired authentication token. |
WSInvalidParameterException | 400 - Bad Request | 1002.0 | Invalid parameter supplied to service. |
WSBrochureServiceException | 500 - Internal Server Error | 2010.0 | An unexpected error occured in the Brochure Service. |
WSBrochureVersionNotFoundException | 400 - Bad Request | 1007.0 | Brochure Version not found. |
WSUserNotFoundException | 400 - Bad Request | 1009.0 | User not found. |
WSEmailAlreadyExistsException | 400 - Bad Request | 1010.0 | Email address already exists. |
WSCacheServiceException | 500 - Internal Server Error | 2027.0 | An unexpected error occurred in the Cache Service. |
WSCacheServiceUnavailableException | 500 - Internal Server Error | 2028.0 | The Cache Service is currently unavailable! |
ADDED FOR MEDICAL INTERACT - April 2013 | |||
WSUsernameAlreadyExistsException | 400 - Bad Request | 1012.0 | Username already exists. |
WSPasswordLengthException | 400 - Bad Request | 1013.0 | Password must be between 8 and 30 characters! |
WSPasswordMismatchException | 400 - Bad Request | 1014.0 | Supplied Password and Confirm Password do not match! |
WSInvalidProviderNumberException | 400 - Bad Request | 1015.0 | Invalid Provider Number! |
WSHCPValidationException | 400 - Bad Request | 1016.0 | HCP validation failed! |
WSPasswordServiceException | 500 - Internal Server Error | 2030.0 | An unexpected error occurred in the Password Service! |
WSRefDataServiceException | 500 - Internal Server Error | 2040.0 | An unexpected error occurred in the Reference Data Service! |
ADDED FOR Surveys Aug 2013 | |||
WSSurveyNotFoundException | 400 - Bad Request | 1017.0 | Survey not found. |
WSInvalidSurveyConfigurationException | 400 - Bad Request | 1018.0 | Invalid survey configuration in CMS. |
WSSurveyInactiveOrExpiredException | 410 - Gone | 1020.0 | Survey inactive or expired. |
WSDuplicateSampleSubmittedException | 400 - Bad Request | 1021.0 | Duplicate Sample Order submitted. |
WSSurveyServiceException | 500 - Internal Server Error | 2050.0 | An unexpected error occurred in the Survey Service! |
ADDED FOR MY INTERACT Nov 2013 | |||
WSInvitationToConnectionNotFoundException | 400 - Bad Request | 1019.0 | Invitation to Connect not found. |
WSNotYetRegisteredForMIException | 401 - Unauthorised | 1027.0 | User is not registered for this service. |
WSInvalidMIRegistrationRequestException | 401 - Unauthorised | 1028.0 | User does not satisfy registration requirements. |
WSInvalidMIRegistrationIdException | 401 - Unauthorised | 1029.0 | This registration is invalid or has already been used. |
WSConnectionAlreadyExistsException | 400 - Bad Request | 1030.0 | Connection already exists for User. |
WSInvalidTeamException | 400 - Bad Request | 1031.0 | Invalid Team supplied to service. |
WSContactExistsException | 400 - Bad Request | 1032.0 | Contact already exists. |
WSQRCodeNotFoundException | 400 - Bad Request | 1033 | QR Code not found. |
WSQRCodeInactiveOrDeletedException | 400 - Bad Request | 1034 | QR Code is inactive or deleted. |
WSQRCodeNotActiveYetException | 400 - Bad Request | 1035 | QR Code is not active yet. |
WSQRCodeExpiredException | 400 - Bad Request | 1036 | QR Code has expired. |
WSEmailNotValidatedException | 400 - Bad Request | 1037 | Email address not validated. (or custom message depending) |
WSUserNotEnabledForMIException | 401 - Unauthorised | 1038.0 | Our records show you are an existing nextINTERACT user. Please register to access myINTERACT. |
WSUserNotEnabledForNIException | 401 - Unauthorised | 1039.0 | Our records show you are an existing myINTERACT user. Please contact your nextINTERACT administrator if you wish to l... |
WSDuplicateResponseSubmittedException | 400 - Bad Request | 1040.0 | Duplicate Response submitted. |
WSInvalidEmailDomainNameException | 400 - Bad Request | 1041.0 | Invalid email domain name. |
WSEmailNotFoundException | 400 - Bad Request | 1043.0 | Email address not found. |
WSUserInvalidPasswordException | 400 - Bad Request | 1044.0 | Existing password does not match. |
WSUnsupportedVersionException | 400 - Bad Request | 1048.0 | The version supplied is not supported. |
ADDED FOR Events 2016 | |||
WSEventServiceException | 500 - Internal Server Error | 2070.0 | An unexpected error occurred in the Events Service. |
WSEventServiceUnavailable | 500 - Internal Server Error | 2071.0 | The Events Service is currently unavailable! |
WSEventCancelledException | 400 - Bad Request | 1042.0 | This event has been cancelled. |
WSEventAttendeeNotFoundException | 400 - Bad Request | 1045.0 | Event invite not found. |
SmartLibrary Exceptions | |||
WSSmartLibraryServiceException | 500 - Internal Server Error | 2073.0 | An unexpected error occurred in the Smart Library Service. |
WSMaxFileUploadSizeException | 400 - Bad Request | 1051.0 | Maximum file upload size exceeded. |
SmartDirectory Exceptions | |||
WSSmartDirectoryNotFoundException | 400 - Bad Request | 1065.0 | Smart Directory not found. |
WSSmartDirectoryServiceException | 500 - Internal Server Error | 2080.0 | An unexpected error occurred in the Smart Directory Service. |
WSUserNotConsentedException | 400 - Bad Request | 1066.0 | User not consented. |
WSSmartDirectoryNotEnabledForCompanyException | 400 - Bad Request | 1067.0 | Smart Directory not enabled. |
WSUserContactNotFoundException | 400 - Bad Request | 1068.0 | User Contact not found. |
WSUserNotInSmartDirectoryException | 400 - Bad Request | 1069.0 | User not in Smart Directory. |
Miscellaneous | |||
WSFieldLengthException | 400 - Bad Request | 1049.0 | Field length exceeded. |
WSLimitExceededException | 400 - Bad Request | 1062.0 | System limit have been exceeded |
WSCompanyNotActiveException | 400 - Bad Request | 1080.0 | This company is no longer available, please contact Company representative for further information. |
Membership API Exceptions | |||
WSCompanyApiKeyNotActiveException | 400 - Bad Request | 1082.0 | Company API Key not active. |
WSConnectionStatusNotActiveException | 400 - Bad Request | 1081.0 | Connection status is not active. |
WSIncorrectApiKeyTypeException | 400 - Bad Request | 1083.0 | API Key does not match to api call. |
WSMembershipServiceException | 500 - Internal Server Error | 2082.0 | An unexpected error occurred in the Membership Service. |
WSUserNotActiveException | 400 - Bad Request | 1084.0 | User status is not active. |
WSRecordNotFoundException | 400 - Bad Request | 1085.0 | Record not found. |
WSInvalidSystemConfigurationException | 500 - Internal Server Error | 1087.0 | Invalid system configuration encountered. |
WSAdminAPIServiceException | 500 - Internal Server Error | 2083.0 | An unexpected error occurred in the Admin API Service. |
User Preference Exceptions | |||
WSUserPreferenceServiceException | 500 - Internal Server Error | 2084.0 | An unexpected error occurred in the User Preference Service. |
User Notifications Exceptions | |||
WSUserPreferenceServiceException | 500 - Internal Server Error | ||
SSO Exceptions | |||
WSUserUseFederatedLoginException | 400 - Bad Request | 1089.0 | User is using Single Sign On, please login using alternate login flow. |
WSOAuthServiceException | 500 - Internal Server Error | 2087.0 | An unexpected error occurred in the OAuth Service. |
WSTaxonomyServiceException | 500 - Internal Server Error | 2086.0 | An unexpected error occurred in the Taxonomy Service. |
WSDiscoverableServiceException | 500 - Internal Server Error | 2088.0 | An unexpected error occurred in the Discovery Service. |
WSInvalidPasswordResetException | 400 - Bad Request | 1093.0 | Invalid password reset operation. (Could be 1.) Password UUID does not match database; 2.) Password Reset UUID has ex... |
WSRecentPasswordResetException | 400 - Bad Request | 1094.0 | A recent password reset has been detected. Please update your password. |
SUCCESS | |||
N/A - not an error | 200 - OK | Login successful. | |
N/A - not an error | 200 - OK | Password reset successful. | |
N/A - not an error | 200 - OK | Skin applied. | |
N/A - not an error | 200 - OK | DeviceId registered. | |
N/A - not an error | 200 - OK | Connection updated. | |
N/A - not an error | 200 - OK | MI User registered. | |
N/A - not an error | 200 - OK | User email validated. | |
N/A - not an error | 200 - OK | MI User invited. | |
N/A - not an error | 200 - OK | Event attendance status updated. | |
N/A - not an error | 200 - OK | Event invite status updated. | |
N/A - not an error | 200 - OK | Event invite sent. | |
N/A - not an error | 200 - OK | User password change successful. | |
OK | 200 - OK | OK |
Error Response Format ​
Error responses are returned as JSON with the following structure:
json
{"errorCode":1005,"errorMsg":"Failed to authenticate User with supplied credentials."}