STEPSTools

Location Skip Navigation LinksAPI DocumentationError Messages

Error Messages


Table of Contents

Description

This is the format standardized across the STEPSTools services for any error messages returned by the service.

Output Values

All error messages are contained in an xml node "ErrorEnvelope". The envelope will contain errors that occurred and inputs that were received


Errors

The errors are displayed in the following format:

Tag name Type Description
Code String A unique code identifying the error. See the glossary below for definitions of what specific codes mean.
Type String A category for the type of error.
Explanation String A description of the error.
 
Inputs

The inputs section contains those values which were received by STEPSTools from your system or were assumed as inputs by the STEPSTools rounding algorithm. This is provided as feedback to help developers who are troubleshooting calls to the service. The xml is a series of "ServiceInput" nodes, one for each input that is either received or assumed. Each "ServiceInput" node has the following child nodes:

Tag name Type Description
ValidParameter string This is the name of the parameter.
Value string The is the value for the valid parameter.
ReceivedOrAssumed string This indicates whether the value was received from your system or assumed by STEPSTools.
 

Example Error Message

Glossary of Error Messages

CodeTypeParameterExplanation
SS100Unexpected errornot applicableThe service encountered an error that was not expected or handled within the code. It may be caused by a bug. Please, report this to a member of the STEPSTools technical team.
SS200Rounding Not Applicablenot applicableThe specified medication is known to STEPSTools. However, STEPSTools does not have a recommendation for this medication because rounding is not applicable for it.
SS201Times Per Day Data Not Foundnot applicableThe service did not find data in the STEPSTools knowledge base for the specified medication. Please, notify a STEPSTools administrator that this information needs to be added to the database.
SS202Formulation Match Failurenot applicableThe specified clinicalDrugId matches more than one formulation in the STEPSTools knowledge base. This needs to be resolved by the STEPSTools technical team. Please, notify them at http://www.pedstep.org/PedStep/Contact.aspx.
SS203Compounding File Not Foundnot applicableSTEPSTools could not find a file for the current version of the compounding database. Please, notify a STEPSTools administrator.
SS300Missing Parameterthis error can occur on a variety of parametersYou did not specify a parameter that is required for the method. When calling the service, this error will return the specific parameter and an example of how to use it.
SS301Invalid Method ParametermethodYou specified an invalid method. When calling the service, this error will return a list of legal method names for the service.
SS302Missing Method ParametermethodYou didn't specify a method. This is required when calling the service. When calling the service, this error message will include a list of legal method names.
SS303Unrecognized Dosing FormuladosingFormulaYou specified a value for the dosingFormula parameter which STEPSTools did not recognize. For STEPSTools to recognize the dosing formula, you should use format "90 mg/kg/day".
SS304Method Requires Per Dose DosingdosingFormulaYou specified a value of the dosingFormula parameter which was not recognized as a per dose dosing formula on a method which requires a per dose dosing formula.
SS305Method Requires Per Day DosingdosingFormulaYou specified a value of the dosingFormula parameter which was not recognized as a per day dosing formula on a method which requires a per day dosing formula.
SS306Unrecognized Version NumberschemaVersionYou supplied a schemaVersion which was not recognized.
SS307Unrecognized FrequencyfrequencyYou supplied a value which is not recognized for frequency.
SS400Invalid Authentication TokenauthTokenYou supplied a value for the "authToken" parameter which was not a valid token. Use the "Login" method of the service to acquire a new valid token.
SS401Invalid User NameusernameYou supplied a username which was not recognized as a valid account on pedstep.org.
SS402Invalid PasswordpasswordYou supplied a valid username, but the password was not valid for that user account.
SS403Insufficient User Privilegesnot applicableYou supplied a valid username or authToken, but the account does not have access to be able to request authTokens for the service. Contact the STEPSTools technical team using http://www.pedstep.org/PedStep/Contact.aspx to request access.
SS404Insufficient Token PrivilegesauthTokenThe token you supplied when attempting to access the production server is valid for testing, but the associated account has not been granted production privileges. Contact the STEPSTools technical team using http://www.pedstep.org/PedStep/Contact.aspx to request access.
SS405Expired TokenauthTokenThe authToken you supplied was valid at one time, however, you currently do not have sufficient privileges on your account to perform the attempted call on the STEPSTools service. Please, contact the STEPSTools technical team using http://www.pedstep.org/PedStep/Contact.aspx to get it resolved.
SS500Formulation Not FoundvocabIdThe specified vocabId did not match any formulations in the STEPSTools knowledge base.
SS501Medication Not Foundvocab,vocabId,medicationStringThe service was unable to match any medication in the STEPSTools knowledgebase using specified values of you specified for vocab, vocabId, or medicationString parameters.
SS600Invalid Data For Parameterthis error can occur on a variety of parametersYou supplied a value which is not a recognized value for this parameter. When calling the service, the error message will include the parameter and the value that was specified which caused the error.