Package com.ringcentral.paths.restapi.account.extension.emergencylocations

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.extension.emergencylocations.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	locationId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String locationId)

Method Summary

Modifier and Type	Method	Description
String	delete()
String	delete(DeleteExtensionEmergencyLocationParameters queryParams)	Deletes a personal emergency response location by ID by the current user or admin.
CommonEmergencyLocationResource	get()	Returns a personal emergency response location for the current user.
EmergencyLocationsResource	list()
EmergencyLocationsResource	list(GetExtensionEmergencyLocationsParameters queryParams)	Returns a list of emergency response locations available for the particular extension.
String	path()
String	path(Boolean withParameter)
CommonEmergencyLocationResource	post(CreateUserEmergencyLocationRequest createUserEmergencyLocationRequest)	Creates a personal emergency response location for the current user.
CommonEmergencyLocationResource	put(EmergencyLocationInfoRequest emergencyLocationInfoRequest)	Updates a personal emergency response location by the current user or admin.

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

locationId

public String locationId

Constructor Details

Index

public Index(Index parent,
 String locationId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public EmergencyLocationsResource list(GetExtensionEmergencyLocationsParameters queryParams)
                                throws RestException,
IOException

Returns a list of emergency response locations available for the particular extension. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/emergency-locations Rate Limit Group: Light App Permission: ReadAccounts

Throws:

RestException

IOException

list

public EmergencyLocationsResource list()
                                throws RestException,
IOException

Throws:

RestException

IOException

post

public CommonEmergencyLocationResource post(CreateUserEmergencyLocationRequest createUserEmergencyLocationRequest)
                                     throws RestException,
IOException

Creates a personal emergency response location for the current user. HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/emergency-locations Rate Limit Group: Heavy App Permission: EditAccounts User Permission: EmergencyFramework

Throws:

RestException

IOException

get

public CommonEmergencyLocationResource get()
                                    throws RestException,
IOException

Returns a personal emergency response location for the current user. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/emergency-locations/{locationId} Rate Limit Group: Light App Permission: ReadAccounts

Throws:

RestException

IOException

put

public CommonEmergencyLocationResource put(EmergencyLocationInfoRequest emergencyLocationInfoRequest)
                                    throws RestException,
IOException

Updates a personal emergency response location by the current user or admin.

HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/emergency-locations/{locationId} Rate Limit Group: Light App Permission: EditAccounts User Permission: EmergencyFramework

Throws:

RestException

IOException

delete

public String delete(DeleteExtensionEmergencyLocationParameters queryParams)
              throws RestException,
IOException

Deletes a personal emergency response location by ID by the current user or admin. Multiple personal emergency response locations can be deleted by single API call.

HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/emergency-locations/{locationId} Rate Limit Group: Heavy App Permission: EditAccounts User Permission: EmergencyFramework

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Throws:

RestException

IOException