C# Class Socrata.ApiBase

Base class under which all Socrata classes inherit.

Protected Properties

Property	Type	Description
_log	log4net.ILog
appToken	string
batchQueue	List
credentials	System.Net.NetworkCredential
httpBase	string

Method	Description
ApiBase ( ) : System
sendBatchRequest ( ) : void	Processess any batch requests saved up in the queue

Method	Description
GetRequest ( String url ) : JsonPayload	Performs a generic GET request on the API server
MapToJson ( string>.Dictionary data ) : Newtonsoft.Json.Linq.JObject
PostRequest ( String url, String parameters ) : JsonPayload	Performs a generice POST request on the API server
UploadFile ( String url, String file ) : JsonPayload	For uploading a file and returning JSON response.
genericWebRequest ( String url, String parameters, String method ) : JsonPayload
getAuthorization ( ) : string
responseIsClean ( JsonPayload response ) : bool	Checks response object to see if any errors are present

public ApiBase ( ) : System
return	System

Performs a generic GET request on the API server

protected GetRequest ( String url ) : JsonPayload
url	String	The URL to request from
return	JsonPayload

protected static MapToJson ( string>.Dictionary data ) : Newtonsoft.Json.Linq.JObject
data	string>.Dictionary
return	Newtonsoft.Json.Linq.JObject

Performs a generice POST request on the API server

protected PostRequest ( String url, String parameters ) : JsonPayload
url	String	Where to send the post request
parameters	String	The data to accompany the post request
return	JsonPayload

For uploading a file and returning JSON response.

protected UploadFile ( String url, String file ) : JsonPayload
url	String	Where to upload the file
file	String	The file location on disk
return	JsonPayload

protected genericWebRequest ( String url, String parameters, String method ) : JsonPayload
url	String
parameters	String
method	String
return	JsonPayload

protected getAuthorization ( ) : string
return	string

Checks response object to see if any errors are present

protected responseIsClean ( JsonPayload response ) : bool
response	JsonPayload	The JSON response returned from the server
return	bool

Processess any batch requests saved up in the queue

public sendBatchRequest ( ) : void
return	void

protected static ILog,log4net _log
return	log4net.ILog

protected string appToken
return	string

protected List batchQueue
return	List

protected NetworkCredential,System.Net credentials
return	System.Net.NetworkCredential

protected string httpBase
return	string