|
|
| Line 2: |
Line 2: |
| | | | |
| | == General error codes == | | == General error codes == |
| − | : 4000: Bad Request
| + | {| |
| − | : 4010: Unauthorized
| + | |
| − | : 4011: Unauthorized [Practice does not exist]
| + | |
| − | : 4012: Unauthorized [User does not exist]
| + | |
| − | : 4013: No token found
| + | |
| − | : 4060: [This code is for a validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.]
| + | |
| − | : 4070: Invalid recipient
| + | |
| − | : 4071: Recipient not found
| + | |
| | | | |
| | {{Response Code 4000}} | | {{Response Code 4000}} |
| Line 19: |
Line 12: |
| | {{Response Code 4070}} | | {{Response Code 4070}} |
| | {{Response Code 4071}} | | {{Response Code 4071}} |
| | + | |- |
| | | | |
| | == Practice error codes == | | == Practice error codes == |
Revision as of 17:22, 21 November 2013
The response codes returned by the Updox API are either 2000s, 4000s, or 5000s. Codes in the 2000s represent a successful response, codes in the 4000s represent a client error, and codes in the 5000s represent a server error. This page outlines all of the 4000, client error, response codes currently in use.
General error codes
Bad Request
Unauthorized
Unauthorized [Practice does not exist or is inactive]
Unauthorized [User does not exist or is inactive]
No token found
[This code is for a validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.]
Invalid recipient
Recipient not found
Practice error codes
- 4110: no practice ID
- 4130: account already exists
- 4131: account does not exist
- 4140: web address is already taken
User error codes
- 4210: no user ID
- 4230: user already exists
- 4231: user does not exist
- 4240: user does not exist; use PracticeUpdate instead
- 4250: user dob invalid
Contact error codes
- 4330: contact already exists
- 4331: contact does not exist
Message error codes
- 4410: message not found
- 4420: no actions found
Direct address error codes
- 4610: direct address error: direct address is taken
- 4620: direct address error: domain does not match the direct domain for this account
- 4630: direct address error: account does not have a direct domain configured
- 4640: direct address error: invalid direct address
- 4641: direct address error: no direct address found for this user
- 4651: direct error: send failed and/or invalid direct address
- 4652: direct error: either from or patientDemographics is required
Patient error codes
- 4730: patient account already exists
- 4731: patient account does not exist
Portal error codes
- 4830: portal account already exists
- 4831: portal account does not exist
