Package com.ringcentral.paths.webinar.registration.v1.sessions

Class Index

java.lang.Object

com.ringcentral.paths.webinar.registration.v1.sessions.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	sessionId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String sessionId)

Method Summary

Modifier and Type	Method	Description
RegSessionModel	get()	Returns a registration Session information by ID.
RegSessionModel	patch(RegSessionModel regSessionModel)	Updates a Session by ID.
String	path()
String	path(Boolean withParameter)
Index	registrants()
Index	registrants(String registrantId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

sessionId

public String sessionId

Constructor Details

Index

public Index(Index parent,
 String sessionId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

get

public RegSessionModel get()
                    throws RestException,
IOException

Returns a registration Session information by ID.

A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission.

HTTP Method: get Endpoint: /webinar/registration/v1/sessions/{sessionId} Rate Limit Group: Heavy App Permission: ReadWebinars

Throws:

RestException

IOException

patch

public RegSessionModel patch(RegSessionModel regSessionModel)
                      throws RestException,
IOException

Updates a Session by ID.

This is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed.

A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission.

If a session record with given ID doesn't exist on Registration Service side the API should return HTTP 404.

HTTP Method: patch Endpoint: /webinar/registration/v1/sessions/{sessionId} Rate Limit Group: Heavy App Permission: EditWebinars

Throws:

RestException

IOException

registrants

public Index registrants()

registrants

public Index registrants(String registrantId)