| GET | /Ams/QuickBooksOnlineOAuth | Communicates to QuickBooksOnline provider for authentication/authorization/access. | |
|---|---|---|---|
| GET | /Ams/{clientId}/QuickBooksOnlineOAuth/{realmid}/RefreshAccessToken/{refreshToken} | Communicates to QuickBooksOnline provider for refreshing an access token. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/QuickBooksOnlineOAuth HTTP/1.1 Host: ws.yourmembership.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AccessToken: String,
AccessTokenExpires: 0001-01-01,
RefreshToken: String,
RefreshTokenExpires: 0001-01-01,
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
}