Interface PassthroughResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
Interface used to encapsulate resources that are just pass throughs to more implmentation specific uses.
public interface PassthroughResources
Methods
DeleteRequest(string)
Issue an HTTP DELETE request
string DeleteRequest(string endpoint)
Parameters
endpoint
stringthe API endpoint
Returns
- string
a JSON response string
Exceptions
- InvalidOperationException
if any argument is null or an empty string
- InvalidRequestException
if there is any problem with the REST API request
- AuthorizationException
if there is any problem with the REST API authorization (access token)
- ResourceNotFoundException
if the resource cannot be found
- ServiceUnavailableException
if the REST API service is not available (possibly due to rate limiting)
- SmartsheetException
if there is any other error during the operation
GetRequest(string, IDictionary<string, string>?)
Issue an HTTP GET request
string GetRequest(string endpoint, IDictionary<string, string>? parameters = null)
Parameters
endpoint
stringthe API endpoint
parameters
IDictionary<string, string>optional list of resource parameters
Returns
- string
a JSON response string
Exceptions
- InvalidOperationException
if any argument is null or an empty string
- InvalidRequestException
if there is any problem with the REST API request
- AuthorizationException
if there is any problem with the REST API authorization (access token)
- ResourceNotFoundException
if the resource cannot be found
- ServiceUnavailableException
if the REST API service is not available (possibly due to rate limiting)
- SmartsheetException
if there is any other error during the operation
PostRequest(string, string, IDictionary<string, string>?)
Issue an HTTP POST request
string PostRequest(string endpoint, string payload, IDictionary<string, string>? parameters = null)
Parameters
endpoint
stringthe API endpoint
payload
stringa JSON payload string
parameters
IDictionary<string, string>optional list of resource parameters
Returns
- string
a JSON response string
Exceptions
- InvalidOperationException
if any argument is null or an empty string
- InvalidRequestException
if there is any problem with the REST API request
- AuthorizationException
if there is any problem with the REST API authorization (access token)
- ResourceNotFoundException
if the resource cannot be found
- ServiceUnavailableException
if the REST API service is not available (possibly due to rate limiting)
- SmartsheetException
if there is any other error during the operation
PutRequest(string, string, IDictionary<string, string>?)
Issue an HTTP PUT request
string PutRequest(string endpoint, string payload, IDictionary<string, string>? parameters = null)
Parameters
endpoint
stringthe API endpoint
payload
stringa JSON payload string
parameters
IDictionary<string, string>optional list of resource parameters
Returns
- string
a JSON response string
Exceptions
- InvalidOperationException
if any argument is null or empty string
- InvalidRequestException
if there is any problem with the REST API request
- AuthorizationException
if there is any problem with the REST API authorization (access token)
- ResourceNotFoundException
if the resource cannot be found
- ServiceUnavailableException
if the REST API service is not available (possibly due to rate limiting)
- SmartsheetException
if there is any other error during the operation