YM REST Services

QuickBooksOnlineOAuth

The following routes are available for this service:
GET	/Ams/{clientId}/QuickBooksOnlineOAuth/{realmid}/RefreshAccessToken/{refreshToken}	Communicates to QuickBooksOnline provider for refreshing an access token.
GET	/Ams/QuickBooksOnlineOAuth	Communicates to QuickBooksOnline provider for authentication/authorization/access.

**QuickBooksOnlineOAuth** Parameters:
Name	Parameter	Data Type	Required
adminId	query	int	No
clientId	path	int	No
realmid	path	string	No
returnUrl	query	string	No
disconnect	query	bool	No
refreshToken	path	string	No
code	query	string	No
state	query	string	No
error_reason	query	string	No
error	query	string	No
error_code	query	string	No
error_description	query	string	No

**QuickBooksOnlineOAuthResponse** Parameters:
Name	Parameter	Data Type	Required
AccessToken	form	string	No
AccessTokenExpires	form	DateTime?	No
RefreshToken	form	string	No
RefreshTokenExpires	form	DateTime?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{clientId}/QuickBooksOnlineOAuth/{realmid}/RefreshAccessToken/{refreshToken} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QuickBooksOnlineOAuthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <adminId>0</adminId>
  <clientId>0</clientId>
  <code>String</code>
  <disconnect>false</disconnect>
  <error>String</error>
  <error_code>String</error_code>
  <error_description>String</error_description>
  <error_reason>String</error_reason>
  <realmid>String</realmid>
  <refreshToken>String</refreshToken>
  <returnUrl>String</returnUrl>
  <state>String</state>
  <AccessToken>String</AccessToken>
  <AccessTokenExpires>0001-01-01T00:00:00</AccessTokenExpires>
  <RefreshToken>String</RefreshToken>
  <RefreshTokenExpires>0001-01-01T00:00:00</RefreshTokenExpires>
</QuickBooksOnlineOAuthResponse>