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

Class Index

java.lang.Object

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

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	registrantId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String registrantId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes a Registrant by ID.
RegistrantModelWithQuestionnaire	get()
RegistrantModelWithQuestionnaire	get(RcwRegGetRegistrantParameters queryParams)	Returns a Registrant by ID.
RegistrantListResource	list()
RegistrantListResource	list(RcwRegListRegistrantsParameters queryParams)	Returns the list of Registrants ordered by "id" ascending.
String	path()
String	path(Boolean withParameter)
RegistrantModelResponsePostWithQuestionnaire	post(RegistrantBaseModelWithQuestionnaire registrantBaseModelWithQuestionnaire)	Creates a new Registrant for a given session.

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

registrantId

public String registrantId

Constructor Details

Index

public Index(Index parent,
 String registrantId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public RegistrantListResource list(RcwRegListRegistrantsParameters queryParams)
                            throws RestException,
IOException

Returns the list of Registrants ordered by "id" ascending.

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}/registrants Rate Limit Group: Heavy App Permission: ReadWebinars

Throws:

RestException

IOException

list

public RegistrantListResource list()
                            throws RestException,
IOException

Throws:

RestException

IOException

post

public RegistrantModelResponsePostWithQuestionnaire post(RegistrantBaseModelWithQuestionnaire registrantBaseModelWithQuestionnaire)
                                                  throws RestException,
IOException

Creates a new Registrant for a given session.

Registration MUST be open for the session for this call to succeed (otherwise it should return HTTP 403).

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: post Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants Rate Limit Group: Heavy App Permission: EditWebinars

Throws:

RestException

IOException

get

public RegistrantModelWithQuestionnaire get(RcwRegGetRegistrantParameters queryParams)
                                     throws RestException,
IOException

Returns a Registrant 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}/registrants/{registrantId} Rate Limit Group: Heavy App Permission: ReadWebinars

Throws:

RestException

IOException

get

public RegistrantModelWithQuestionnaire get()
                                     throws RestException,
IOException

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes a Registrant by ID.

Session must not be in finished state (otherwise it should return HTTP 403).

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: delete Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId} Rate Limit Group: Heavy App Permission: EditWebinars

Throws:

RestException

IOException