Difference between revisions of "Error Codes"
From Updox API
| Line 15: | Line 15: | ||
== Practice error codes == | == Practice error codes == | ||
| + | {{Error Code Table Header}} | ||
| + | {{Response Code Table Row|4110}} | ||
| + | {{Response Code Table Row|4130}} | ||
| + | {{Response Code Table Row|4131}} | ||
| + | {{Response Code Table Row|4140}} | ||
| + | |} | ||
: 4110: no practice ID | : 4110: no practice ID | ||
: 4130: account already exists | : 4130: account already exists | ||
| Line 20: | Line 26: | ||
: 4140: web address is already taken | : 4140: web address is already taken | ||
| − | == User error codes == | + | == User error codes == |
| + | {{Error Code Table Header}} | ||
| + | {{Response Code Table Row|4210}} | ||
| + | {{Response Code Table Row|4230}} | ||
| + | {{Response Code Table Row|4231}} | ||
| + | {{Response Code Table Row|4240}} | ||
| + | {{Response Code Table Row|4250}} | ||
: 4210: no user ID | : 4210: no user ID | ||
: 4230: user already exists | : 4230: user already exists | ||
: 4231: user does not exist | : 4231: user does not exist | ||
: 4240: user does not exist; use PracticeUpdate instead | : 4240: user does not exist; use PracticeUpdate instead | ||
| − | : 4250: user dob invalid | + | : 4250: user dob invalid |
| + | |} | ||
== Contact error codes == | == Contact error codes == | ||
| + | {{Error Code Table Header}} | ||
| + | {{Response Code Table Row|4330}} | ||
| + | {{Response Code Table Row|4331}} | ||
: 4330: contact already exists | : 4330: contact already exists | ||
: 4331: contact does not exist | : 4331: contact does not exist | ||
| + | |} | ||
== Message error codes == | == Message error codes == | ||
| + | {{Error Code Table Header}} | ||
| + | {{Response Code Table Row|4410}} | ||
| + | {{Response Code Table Row|4420}} | ||
: 4410: message not found | : 4410: message not found | ||
: 4420: no actions found | : 4420: no actions found | ||
| + | |} | ||
== Direct address error codes == | == Direct address error codes == | ||
| + | {{Error Code Table Header}} | ||
| + | {{Response Code Table Row|4610}} | ||
| + | {{Response Code Table Row|4620}} | ||
| + | {{Response Code Table Row|4630}} | ||
| + | {{Response Code Table Row|4640}} | ||
| + | {{Response Code Table Row|4641}} | ||
| + | {{Response Code Table Row|4651}} | ||
| + | {{Response Code Table Row|4652}} | ||
: 4610: direct address error: direct address is taken | : 4610: direct address error: direct address is taken | ||
: 4620: direct address error: domain does not match the direct domain for this account | : 4620: direct address error: domain does not match the direct domain for this account | ||
| Line 43: | Line 72: | ||
: 4651: direct error: send failed and/or invalid direct address | : 4651: direct error: send failed and/or invalid direct address | ||
: 4652: direct error: either from or patientDemographics is required | : 4652: direct error: either from or patientDemographics is required | ||
| + | |} | ||
== Patient error codes == | == Patient error codes == | ||
| + | {{Error Code Table Header}} | ||
| + | {{Response Code Table Row|4730}} | ||
| + | {{Response Code Table Row|4731}} | ||
: 4730: patient account already exists | : 4730: patient account already exists | ||
: 4731: patient account does not exist | : 4731: patient account does not exist | ||
| + | |} | ||
== Portal error codes == | == Portal error codes == | ||
| + | {{Error Code Table Header}} | ||
| + | {{Response Code Table Row|4830}} | ||
| + | {{Response Code Table Row|4831}} | ||
: 4830: portal account already exists | : 4830: portal account already exists | ||
: 4831: portal account does not exist | : 4831: portal account does not exist | ||
| + | |} | ||
Revision as of 18:21, 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.
Contents |
General error codes
| Code | Message |
|---|---|
4000
|
Bad Request
|
4010
|
Unauthorized
|
4011
|
Unauthorized [Practice does not exist or is inactive]
|
4012
|
Unauthorized [User does not exist or is inactive]
|
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
|
Practice error codes
| Code | Message |
|---|---|
4110
|
no practice ID
|
4130
|
account already exists
|
4131
|
account does not exist
|
4140
|
web address is already taken
|
- 4110: no practice ID
- 4130: account already exists
- 4131: account does not exist
- 4140: web address is already taken
User error codes
| Code | Message |
|---|---|
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
| Code | Message |
|---|---|
4330
|
contact already exists
|
4331
|
contact does not exist
|
Message error codes
| Code | Message |
|---|---|
4410
|
message not found
|
4420
|
no actions found
|
Direct address error codes
| Code | Message |
|---|---|
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 sending user
|
4651
|
direct error: send failed and/or invalid direct address
|
4652
|
direct error: either from or patientDemographics is required
|
Patient error codes
| Code | Message |
|---|---|
4730
|
patient account already exists
|
4731
|
patient account does not exist
|
Portal error codes
| Code | Message |
|---|---|
4830
|
portal account already exists
|
4831
|
portal account does not exist
|
