C# Class CallfireApiClient.Api.Campaigns.BatchesApi

Show file Open project: CallFire/callfire-api-client-csharp

Public Methods

Method Description
Get ( long id, string fields = null ) : Batch

Returns a single Batch instance for a given batch id. This API is useful for determining the state of a validating batch.
Update ( Batch batch ) : void

Update batch

Private Methods

Method Description
BatchesApi ( RestApiClient client ) : System.Collections.Generic

Method Details

Get() public method

Returns a single Batch instance for a given batch id. This API is useful for determining the state of a validating batch.
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Get ( long id, string fields = null ) : Batch
id long id of batch
fields string limit fields returned. Example fields=id,name
return Batch

Update() public method

Update batch
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Update ( Batch batch ) : void
batch Batch batch to update
return void