YM REST Services

<back to all web services

ZoomOAuth

The following routes are available for this service:
GET/Ams/{clientId}/ZoomOAuth/{realmid}/RefreshAccessToken/{refreshToken}Communicates to Zoom provider for refreshing an access token.
GET/Ams/ZoomOAuthCommunicates to Zoom provider for authentication/authorization/access.
ZoomOAuth Parameters:
NameParameterData TypeRequiredDescription
adminIdqueryintNo
clientIdpathintNo
returnUrlquerystringNo
disconnectqueryboolNo
refreshTokenpathstringNo
codequerystringNo
statequerystringNo
error_reasonquerystringNo
errorquerystringNo
error_codequerystringNo
error_descriptionquerystringNo
ZoomOAuthResponse Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformstringNo
AccessTokenExpiresformDateTime?No
RefreshTokenformstringNo
RefreshTokenExpiresformDateTime?No

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

HTTP + JSV

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

GET /Ams/{clientId}/ZoomOAuth/{realmid}/RefreshAccessToken/{refreshToken} 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,
	returnUrl: String,
	disconnect: False,
	refreshToken: String,
	code: String,
	state: String,
	error_reason: String,
	error: String,
	error_code: String,
	error_description: String
}