Difference between revisions of "FAQ"

From Updox API
Jump to: navigation, search
Line 13: Line 13:
 
== I'm getting a 4011 or 4012 response - why? ==
 
== I'm getting a 4011 or 4012 response - why? ==
 
These error messages are returned when either the supplied [[API_Method_UpdatePractice|practice/accountid is not active]] or the supplied [[API_Method_UpdateUser|user is not active]].
 
These error messages are returned when either the supplied [[API_Method_UpdatePractice|practice/accountid is not active]] or the supplied [[API_Method_UpdateUser|user is not active]].
 +
 +
== Can one practice have multiple accountIds? ==
 +
AccountId is unique for a practice. If the same practice wants multiple accounts, you must create unique accounts with unique accountIds and duplicate all of the users and settings across both accounts.
 +
 +
== What happens if we don't provide a direct address when setting up a '''practice'''? ==
 +
If no direct address is provided, direct.updoxqa.com is the default direct address for the practice.
 +
 +
== What happens if we don't provide a direct address when setting up a '''user'''? ==
 +
If no direct address is provided, the user will be unable to send direct messages - there is no default value.
 +
 +
== Must Direct addresses be unique within the domain? ==
 +
Yes.  There is no way to distinguish different users with identical direct addresses, even if they belong to different accounts or vendors.
 +
 +
== How do we remove a user or account? ==
 +
Calling the respective update method for updating the [[User_Management|user]] or [[Account_Management|account]] and setting the <code>active</code> to <code>false</code> will accomplish this.

Revision as of 10:37, 3 December 2013

Contents

How can we set up test accounts?

Quickstart

What is "vetting" and how does it work?

Vetting

What is the URL to access the Webapp outside the API?

https://updoxqa.com/app/html/login.html

What HTTP Methods are supported?

All API calls should be done using the POST HTTP method.

I'm getting a 4011 or 4012 response - why?

These error messages are returned when either the supplied practice/accountid is not active or the supplied user is not active.

Can one practice have multiple accountIds?

AccountId is unique for a practice. If the same practice wants multiple accounts, you must create unique accounts with unique accountIds and duplicate all of the users and settings across both accounts.

What happens if we don't provide a direct address when setting up a practice?

If no direct address is provided, direct.updoxqa.com is the default direct address for the practice.

What happens if we don't provide a direct address when setting up a user?

If no direct address is provided, the user will be unable to send direct messages - there is no default value.

Must Direct addresses be unique within the domain?

Yes. There is no way to distinguish different users with identical direct addresses, even if they belong to different accounts or vendors.

How do we remove a user or account?

Calling the respective update method for updating the user or account and setting the active to false will accomplish this.