Difference between revisions of "Error Codes"

From Updox API
Jump to: navigation, search
(Init)
 
(→‎Notification error codes)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
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 ==  
 
== General error codes ==  
−
: 4000: Bad Request 
+
{{Error Code Table Header}}
−
: 4010: Unauthorized 
+
{{Response Code Table Row|4000}}
−
: 4011: Unauthorized [Practice does not exist] 
+
{{Response Code Table Row|4010}}
−
: 4012: Unauthorized [User does not exist] 
+
{{Response Code Table Row|4011}}
−
: 4013: No token found 
+
{{Response Code Table Row|4012}}
−
: 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.] 
+
{{Response Code Table Row|4013}}
−
: 4070: Invalid recipient 
+
{{Response Code Table Row|4014}}
−
: 4071: Recipient not found 
+
{{Response Code Table Row|4020}}
−
 
+
{{Response Code Table Row|4060}}
 +
{{Response Code Table Row|4070}}
 +
{{Response Code Table Row|4071}}
 +
{{Response Code Table Row|4072}}
 +
{{Response Code Table Row|4073}}
 +
{{Response Code Table Row|4074}}
 +
{{Response Code Table Row|4075}}
 +
{{Response Code Table Row|4076}}
 +
{{Response Code Table Row|4077}}
 +
{{Response Code Table Row|4080}}
 +
|}
 +
 
 
== Practice error codes ==
 
== Practice error codes ==
−
: 4110: no practice ID 
+
{{Error Code Table Header}}
−
: 4130: account already exists 
+
{{Response Code Table Row|4110}}
−
: 4131: account does not exist 
+
{{Response Code Table Row|4130}}
−
: 4140: web address is already taken 
+
{{Response Code Table Row|4131}}
−
 
+
{{Response Code Table Row|4132}}
−
== User error codes ==   
+
{{Response Code Table Row|4140}}
−
: 4210: no user ID 
+
{{Response Code Table Row|4150}}
−
: 4230: user already exists 
+
|}
−
: 4231: user does not exist 
+
 
−
: 4240: user does not exist; use PracticeUpdate instead 
+
== User error codes ==
−
: 4250: user dob invalid 
+
{{Error Code Table Header}}  
−
 
+
{{Response Code Table Row|4210}}
 +
{{Response Code Table Row|4230}}
 +
{{Response Code Table Row|4231}}
 +
{{Response Code Table Row|4232}}
 +
{{Response Code Table Row|4233}}
 +
{{Response Code Table Row|4240}}
 +
{{Response Code Table Row|4250}}
 +
|}
 +
 
 
== Contact error codes ==
 
== Contact error codes ==
−
: 4330: contact already exists  
+
{{Error Code Table Header}}  
−
: 4331: contact does not exist 
+
{{Response Code Table Row|4330}}
 +
{{Response Code Table Row|4331}}
 +
|}
 
    
 
    
 
== Message error codes ==
 
== Message error codes ==
−
: 4410: message not found 
+
{{Error Code Table Header}}
−
: 4420: no actions found 
+
{{Response Code Table Row|4410}}
 +
{{Response Code Table Row|4420}}
 +
{{Response Code Table Row|4430}}
 +
|}
 
   
 
   
 
== Direct address error codes ==
 
== Direct address error codes ==
−
: 4610: direct address error: direct address is taken 
+
{{Error Code Table Header}}
−
: 4620: direct address error: domain does not match the direct domain for this account 
+
{{Response Code Table Row|4610}}
−
: 4630: direct address error: account does not have a direct domain configured 
+
{{Response Code Table Row|4620}}
−
: 4640: direct address error: invalid direct address 
+
{{Response Code Table Row|4621}}
−
: 4641: direct address error: no direct address found for this user 
+
{{Response Code Table Row|4630}}
−
: 4651: direct error: send failed and/or invalid direct address 
+
{{Response Code Table Row|4640}}
−
: 4652: direct error: either from or patientDemographics is required 
+
{{Response Code Table Row|4641}}
 +
{{Response Code Table Row|4642}}
 +
{{Response Code Table Row|4643}}
 +
{{Response Code Table Row|4650}}
 +
{{Response Code Table Row|4651}}
 +
{{Response Code Table Row|4652}}
 +
|}
 
    
 
    
 
== Patient error codes ==
 
== Patient error codes ==
−
: 4730: patient account already exists 
+
{{Error Code Table Header}}
−
: 4731: patient account does not exist 
+
{{Response Code Table Row|4730}}
 +
{{Response Code Table Row|4731}}
 +
|}
 
    
 
    
 
== Portal error codes ==
 
== Portal error codes ==
−
: 4830: portal account already exists 
+
{{Error Code Table Header}}
−
: 4831: portal account does not exist
+
{{Response Code Table Row|4830}}
 +
{{Response Code Table Row|4831}}
 +
|}
 +
 
 +
== Notification error codes ==
 +
{{Error Code Table Header}}
 +
{{Response Code Table Row|5010}}
 +
{{Response Code Table Row|5011}}
 +
{{Response Code Table Row|5012}}
 +
|}

Latest revision as of 15:46, 11 December 2015

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
4014 Unauthorized
4020 Bad Request: Request likely too large
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
4072 Invalid recipient type, requires PATIENT
4073 Invalid recipient type, requires CONTACT
4074 Invalid recipient type, requires PORTAL
4075 Invalid recipient type, requires DIRECT
4076 Invalid recipient type, requires EMAIL
4077 Invalid recipient type, requires FAX
4080 Recipient unable to receive messages

Practice error codes

Code Message
4110 no practice ID
4130 account already exists
4131 account does not exist
4132 account already has an accountId
4140 web address is already taken
4150 direct domain is already taken

User error codes

Code Message
4210 no user ID
4230 user already exists
4231 user does not exist
4232 user password is required
4233 user password is invalid. Password length must be between 8 and 30 characters, contain at least one upper case AND lower case character, and must contain one number OR special character.
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
4430 message type does not have any MDNs

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
4621 direct address error: domain does not match the direct domain for this vendor
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
4642 direct address error: identity verification required to send to this address
4643 direct address error: RA/CA information required to provision this address
4650 direct error: send failed
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

Notification error codes

Code Message
5010 at least one notification must be provided
5011 the maximum number of notifications per request has been exceeded
5012 at least one id must be specified for the get request
Retrieved from "http://updoxqa.com/wiki/index.php?title=Error_Codes&oldid=3099"