YM REST Services

<back to all web 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/QuickBooksOnlineOAuthCommunicates to QuickBooksOnline provider for authentication/authorization/access.
QuickBooksOnlineOAuth Parameters:
NameParameterData TypeRequiredDescription
adminIdqueryintNo
clientIdpathintNo
realmidpathstringNo
returnUrlquerystringNo
disconnectqueryboolNo
refreshTokenpathstringNo
codequerystringNo
statequerystringNo
error_reasonquerystringNo
errorquerystringNo
error_codequerystringNo
error_descriptionquerystringNo
QuickBooksOnlineOAuthResponse Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformstringNo
AccessTokenExpiresformDateTime?No
RefreshTokenformstringNo
RefreshTokenExpiresformDateTime?No

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"AccessToken":"String","AccessTokenExpires":"0001-01-01T00:00:00.0000000","RefreshToken":"String","RefreshTokenExpires":"0001-01-01T00:00:00.0000000","adminId":0,"clientId":0,"realmid":"String","returnUrl":"String","disconnect":false,"refreshToken":"String","code":"String","state":"String","error_reason":"String","error":"String","error_code":"String","error_description":"String"}