Difference between revisions of "API Method PracticeUpdate"

From Updox API
Jump to: navigation, search
(Request)
(Request)
Line 7: Line 7:
  
 
==== Request ====
 
==== Request ====
{
+
{
    "accountId": "mike",
+
    "accountId": "new-account-id",
    "name": "Mike's Practice",
+
    "name": "Family Practice",
    "address1": "123 Test Dr",
+
    "address1": "94 N. High St",
    "city": "Fantasy Island",
+
    "address2": "Suite 100",
    "state": "IL",
+
    "city": "Dublin",
    "postal": "60750",
+
    "state": "OH",
    "phone": "5555555555",
+
    "postal": "43017",
    "fax": "5555555555",
+
    "phone": "6147988170",
    "websiteAddress": "www.mikedox.com",
+
    "fax": "6144074411",
    "timeZone": "America/Chicago",
+
    "websiteAddress": "practice_website",
    "directDomain": "direct.updoxqa.com",
+
    "timeZone": "America/Chicago",
    "active": "true",
+
    "directDomain": "new_practice",
    "auth": {
+
    "directAddress": "practice_direct",
        "applicationId": "updox",
+
    "active": "true",
        "applicationPassword": "password",
+
      "auth": {
        "accountId": "mike",
+
        "applicationId": "updox",
        "userId": "mike"
+
        "applicationPassword": "1234567890",
    }
+
        "accountId": "account",
}
+
        "userId": "user"
 +
    }
 +
}
  
 
==== Response ====
 
==== Response ====

Revision as of 16:31, 15 November 2013

Update a practice with the given accountId.

Contents

Fields

Please refer to the Interactive API for a list of the fields for this method.

Sample Request and Response

Request

{
    "accountId": "new-account-id",
    "name": "Family Practice",
    "address1": "94 N. High St",
    "address2": "Suite 100",
    "city": "Dublin",
    "state": "OH",
    "postal": "43017",
    "phone": "6147988170",
    "fax": "6144074411",
    "websiteAddress": "practice_website",
    "timeZone": "America/Chicago",
    "directDomain": "new_practice",
    "directAddress": "practice_direct",
    "active": "true",
     "auth": {
        "applicationId": "updox",
        "applicationPassword": "1234567890",
        "accountId": "account",
        "userId": "user"
    }
}

Response

{

   "successful": true,
   "responseMessage": "OK",
   "responseCode": 2000,
   "accountId": "mike",
   "action": "update"

}

Error Codes

In addition to the General Error Set, this method may return:

4110: no practice ID
4131: account does not exist
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
4140: web address is already taken