/// <summary>
/// Passes the request off to the API and returns the results to the caller
/// </summary>
/// <param name="sURI" type="string" ref="false" inout="[in]" description="The full URI to call (use BuildURI to build it up)"/>
/// <param name="sHttpMethod" type="string" ref="false" inout="[in]" description="The HTTP method to call (e.g. GET, PUT, POST, DELETE)"/>
/// <param name="sContentType" type="string" ref="false" inout="[in]" description="The type of data that is being passed as well as the type that is expected to be returned (e.g. text/xml)"/>
/// <param name="sPostPutData" type="string" ref="false" inout="[in]" description="The data to send"/>
/// <param name="sConsumerSecret" type="string" ref="false" inout="[in]" description="The consumer secret/3rd party developer token"/>
/// <param name="sDataAccessToken" type="string" ref="false" inout="[in]" description="The Data Access Token of the person logging in"/>
/// <returns>string (the response from the API)</returns>
/// <history>
/// <modified author="C. Gerard Gallant" date="2011-11-24" reason="Created"/>
/// <modified author="C. Gerard Gallant" date="2012-04-23" reason="Created an overload of this method and pushed the code there"/>
/// <modified author="C. Gerard Gallant" date="2013-03-06" reason="Realized that the Content-Type value was not being passed along in the APIRequestResult object"/>
/// </history>
public static string MakeAPIRequest(string sURI, string sHttpMethod, string sContentType, string sPostPutData,
string sConsumerSecret, string sDataAccessToken)
{
// Create our Request/Result object (3rd param is specified as an empty string since the URI has already been generated...version # is
// only needed when building up the URI)
APIRequestResult aRequestResult = new APIRequestResult(sConsumerSecret, sDataAccessToken, "");
aRequestResult.SetRequestURI(sURI);
aRequestResult.RequestHttpMethod = sHttpMethod;
aRequestResult.RequestPostPutData = sPostPutData;
aRequestResult.ContentType = sContentType;
// Call the overloaded method to handle the work and then return the result object to the caller
MakeAPIRequest(aRequestResult);
// If there was an error then...
if (aRequestResult.HadRequestError)
{
// Return the error in the content type that was originally requested (xml or json)
return(BuildErrorReturnString(aRequestResult.RequestErrorStatus, aRequestResult.GetRequestErrorMessage(), sContentType));
}
else // No errors...
{
// Return the result
return(aRequestResult.RequestResult);
} // End if (aRequestResult.HadRequestError)
}
/// <summary>
/// Passes the request off to the API and returns the results to the caller
/// </summary>
/// <param name="sURI" type="string" ref="false" inout="[in]" description="The full URI to call (use BuildURI to build it up)"/>
/// <param name="sHttpMethod" type="string" ref="false" inout="[in]" description="The HTTP method to call (e.g. GET, PUT, POST, DELETE)"/>
/// <param name="sContentType" type="string" ref="false" inout="[in]" description="The type of data that is being passed as well as the type that is expected to be returned (e.g. text/xml)"/>
/// <param name="sPostPutData" type="string" ref="false" inout="[in]" description="The data to send"/>
/// <param name="sConsumerSecret" type="string" ref="false" inout="[in]" description="The consumer secret/3rd party developer token"/>
/// <param name="sDataAccessToken" type="string" ref="false" inout="[in]" description="The Data Access Token of the person logging in"/>
/// <returns>string (the response from the API)</returns>
/// <history>
/// <modified author="C. Gerard Gallant" date="2011-11-24" reason="Created"/>
/// <modified author="C. Gerard Gallant" date="2012-04-23" reason="Created an overload of this method and pushed the code there"/>
/// <modified author="C. Gerard Gallant" date="2013-03-06" reason="Realized that the Content-Type value was not being passed along in the APIRequestResult object"/>
/// </history>
public static string MakeAPIRequest(string sURI, string sHttpMethod, string sContentType, string sPostPutData,
string sConsumerSecret, string sDataAccessToken)
{
// Create our Request/Result object (3rd param is specified as an empty string since the URI has already been generated...version # is
// only needed when building up the URI)
APIRequestResult aRequestResult = new APIRequestResult(sConsumerSecret, sDataAccessToken, "");
aRequestResult.SetRequestURI(sURI);
aRequestResult.RequestHttpMethod = sHttpMethod;
aRequestResult.RequestPostPutData = sPostPutData;
aRequestResult.ContentType = sContentType;
// Call the overloaded method to handle the work and then return the result object to the caller
MakeAPIRequest(aRequestResult);
// If there was an error then...
if (aRequestResult.HadRequestError)
{
// Return the error in the content type that was originally requested (xml or json)
return BuildErrorReturnString(aRequestResult.RequestErrorStatus, aRequestResult.GetRequestErrorMessage(), sContentType);
}
else // No errors...
{
// Return the result
return aRequestResult.RequestResult;
} // End if (aRequestResult.HadRequestError)
}
/// <history>
/// <modified author="C. Gerard Gallant" date="2012-04-23" reason="Created"/>
/// <modified author="C. Gerard Gallant" date="2012-08-31" reason="Fixed an issue where if there are unicode characters in the content being sent, the content length was not set correctly. sPostPutData.Length is not good enough, need to pass the string through the Encoding.UTF8.GetByteCount function."/>
/// <modified author="C. Gerard Gallant" date="2012-11-26" reason="A coworker is hitting the throttle limit of the API so an attempt to make things easier is being attempted here where we will re-try the call for a limited number of times before just returning with an error."/>
/// </history>
public static void MakeAPIRequest(APIRequestResult aRequestResult)
{
string sContentType = aRequestResult.ContentType;
string sPostPutData = aRequestResult.RequestPostPutData;
try
{
// Build up our request object
HttpWebRequest hwrAPIRequest = (HttpWebRequest)WebRequest.Create(aRequestResult.GetRequestURI());
hwrAPIRequest.Headers["Authorization"] = BuildAuthorizationHeaderContent(aRequestResult.ConsumerSecret, aRequestResult.DataAccessToken);
hwrAPIRequest.Accept = sContentType;
hwrAPIRequest.Method = aRequestResult.RequestHttpMethod; // GET, PUT, POST, DELETE, etc
hwrAPIRequest.ContentType = sContentType;
hwrAPIRequest.ContentLength = Encoding.UTF8.GetByteCount(sPostPutData);//Necessary if the string contains unicode characters
// If there is data to be included with the request then...
if (sPostPutData != "")
{
// Get the request stream and write the body string to it
Stream strOutput = hwrAPIRequest.GetRequestStream();
StreamWriter swWriter = new StreamWriter(strOutput);
swWriter.Write(sPostPutData);
// Close our StreamWriter and Stream objects
swWriter.Flush(); // Make sure the buffers are pushed to the stream before we close the writer
swWriter.Close();
// I don't usually see this in StreamWriter examples but seeing that you can construct multiple StreamWriter objects on the same stream
// after flushing and closing the previous StreamWriter suggest to me that the stream is not closed by the Close call on StreamWriter. As
// a result, make sure our Stream object is closed. The MSDN examples for GetRequestStream DO close the stream when done.
strOutput.Close();
} // End if (sPostPutData != "")
// Make the request and get the response object
HttpWebResponse hwrResponse = (HttpWebResponse)hwrAPIRequest.GetResponse();
// Read in the response
Stream strResponse = hwrResponse.GetResponseStream();
StreamReader srReader = new StreamReader(strResponse);
aRequestResult.RequestResult = srReader.ReadToEnd();
srReader.Close();
strResponse.Close();
// Close the response object
hwrResponse.Close();
}
catch (WebException weException)
{
HttpStatusCode iStatusCode = HttpStatusCode.InternalServerError;
string sDescription = weException.Message;
// If the exception was due to a protocol error (status code 300+) then...
if (weException.Status == WebExceptionStatus.ProtocolError)
{
// Grab the response, its Status Code, and the response stream
HttpWebResponse hwrResponse = (HttpWebResponse)weException.Response;
iStatusCode = hwrResponse.StatusCode;
sDescription = hwrResponse.StatusDescription;
// If this is a throttle error and if we have not yet reached the maximum number of retries then...
if ((iStatusCode == HttpStatusCode.ServiceUnavailable) && (aRequestResult.RequestRetryCount < MAX_REQUEST_RETRY_COUNT))
{
// Sleep for 1 second
Thread.Sleep(1000);
// Increment our counter and make this request again. Exit so that the rest of this funtion doesn't execute.
aRequestResult.RequestRetryCount += 1;
MakeAPIRequest(aRequestResult);
return;
} // End if ((iStatusCode == HttpStatusCode.ServiceUnavailable) && (aRequestResult.RequestRetryCount < MAX_REQUEST_RETRY_COUNT))
Stream sResponseStream = hwrResponse.GetResponseStream();
WebFaultExceptionDetails wfedContent = null;
// If we are dealing with JSON then...
string sResponseContentType = hwrResponse.ContentType;
if (sResponseContentType.Contains(MIME_TYPE_APPLICATION_JSON))
{
// Convert the JSON string into an object and then grab it's description
DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(WebFaultExceptionDetails));
wfedContent = (WebFaultExceptionDetails)ser.ReadObject(sResponseStream);
sDescription = wfedContent.Description;
}
else if ((sResponseContentType.Contains(MIME_TYPE_TEXT_XML)) || (sResponseContentType.Contains(MIME_TYPE_APPLICATION_XML)))
{
// Convert the XML string into an object and then grab it's description
DataContractSerializer ser = new DataContractSerializer(typeof(WebFaultExceptionDetails));
wfedContent = (WebFaultExceptionDetails)ser.ReadObject(sResponseStream);
sDescription = wfedContent.Description;
}
else // Not JSON and not XML (HTML?)...
{
// Grab the content data from the response object and then close the stream reader object
StreamReader srReader = new StreamReader(sResponseStream);
sDescription = srReader.ReadToEnd();
srReader.Close();
}// End if
// Close the response stream and then the response itself
sResponseStream.Close();
hwrResponse.Close();
} // End if (weException.Status == WebExceptionStatus.ProtocolError)
// Build up the return value for the caller for this error message.
aRequestResult.SetRequestErrorMessage(iStatusCode, sDescription);
} // End of the catch (WebException weException) statement.
}
/// <history>
/// <modified author="C. Gerard Gallant" date="2012-04-23" reason="Created"/>
/// <modified author="C. Gerard Gallant" date="2012-08-31" reason="Fixed an issue where if there are unicode characters in the content being sent, the content length was not set correctly. sPostPutData.Length is not good enough, need to pass the string through the Encoding.UTF8.GetByteCount function."/>
/// <modified author="C. Gerard Gallant" date="2012-11-26" reason="A coworker is hitting the throttle limit of the API so an attempt to make things easier is being attempted here where we will re-try the call for a limited number of times before just returning with an error."/>
/// </history>
public static void MakeAPIRequest(APIRequestResult aRequestResult)
{
string sContentType = aRequestResult.ContentType;
string sPostPutData = aRequestResult.RequestPostPutData;
try
{
// Build up our request object
HttpWebRequest hwrAPIRequest = (HttpWebRequest)WebRequest.Create(aRequestResult.GetRequestURI());
hwrAPIRequest.Headers["Authorization"] = BuildAuthorizationHeaderContent(aRequestResult.ConsumerSecret, aRequestResult.DataAccessToken);
hwrAPIRequest.Accept = sContentType;
hwrAPIRequest.Method = aRequestResult.RequestHttpMethod; // GET, PUT, POST, DELETE, etc
hwrAPIRequest.ContentType = sContentType;
hwrAPIRequest.ContentLength = Encoding.UTF8.GetByteCount(sPostPutData); //Necessary if the string contains unicode characters
// If there is data to be included with the request then...
if (sPostPutData != "")
{
// Get the request stream and write the body string to it
Stream strOutput = hwrAPIRequest.GetRequestStream();
StreamWriter swWriter = new StreamWriter(strOutput);
swWriter.Write(sPostPutData);
// Close our StreamWriter and Stream objects
swWriter.Flush(); // Make sure the buffers are pushed to the stream before we close the writer
swWriter.Close();
// I don't usually see this in StreamWriter examples but seeing that you can construct multiple StreamWriter objects on the same stream
// after flushing and closing the previous StreamWriter suggest to me that the stream is not closed by the Close call on StreamWriter. As
// a result, make sure our Stream object is closed. The MSDN examples for GetRequestStream DO close the stream when done.
strOutput.Close();
} // End if (sPostPutData != "")
// Make the request and get the response object
HttpWebResponse hwrResponse = (HttpWebResponse)hwrAPIRequest.GetResponse();
// Read in the response
Stream strResponse = hwrResponse.GetResponseStream();
StreamReader srReader = new StreamReader(strResponse);
aRequestResult.RequestResult = srReader.ReadToEnd();
srReader.Close();
strResponse.Close();
// Close the response object
hwrResponse.Close();
}
catch (WebException weException)
{
HttpStatusCode iStatusCode = HttpStatusCode.InternalServerError;
string sDescription = weException.Message;
// If the exception was due to a protocol error (status code 300+) then...
if (weException.Status == WebExceptionStatus.ProtocolError)
{
// Grab the response, its Status Code, and the response stream
HttpWebResponse hwrResponse = (HttpWebResponse)weException.Response;
iStatusCode = hwrResponse.StatusCode;
sDescription = hwrResponse.StatusDescription;
// If this is a throttle error and if we have not yet reached the maximum number of retries then...
if ((iStatusCode == HttpStatusCode.ServiceUnavailable) && (aRequestResult.RequestRetryCount < MAX_REQUEST_RETRY_COUNT))
{
// Sleep for 1 second
Thread.Sleep(1000);
// Increment our counter and make this request again. Exit so that the rest of this funtion doesn't execute.
aRequestResult.RequestRetryCount += 1;
MakeAPIRequest(aRequestResult);
return;
} // End if ((iStatusCode == HttpStatusCode.ServiceUnavailable) && (aRequestResult.RequestRetryCount < MAX_REQUEST_RETRY_COUNT))
Stream sResponseStream = hwrResponse.GetResponseStream();
WebFaultExceptionDetails wfedContent = null;
// If we are dealing with JSON then...
string sResponseContentType = hwrResponse.ContentType;
if (sResponseContentType.Contains(MIME_TYPE_APPLICATION_JSON))
{
// Convert the JSON string into an object and then grab it's description
DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(WebFaultExceptionDetails));
wfedContent = (WebFaultExceptionDetails)ser.ReadObject(sResponseStream);
sDescription = wfedContent.Description;
}
else if ((sResponseContentType.Contains(MIME_TYPE_TEXT_XML)) || (sResponseContentType.Contains(MIME_TYPE_APPLICATION_XML)))
{
// Convert the XML string into an object and then grab it's description
DataContractSerializer ser = new DataContractSerializer(typeof(WebFaultExceptionDetails));
wfedContent = (WebFaultExceptionDetails)ser.ReadObject(sResponseStream);
sDescription = wfedContent.Description;
}
else // Not JSON and not XML (HTML?)...
{
// Grab the content data from the response object and then close the stream reader object
StreamReader srReader = new StreamReader(sResponseStream);
sDescription = srReader.ReadToEnd();
srReader.Close();
}// End if
// Close the response stream and then the response itself
sResponseStream.Close();
hwrResponse.Close();
} // End if (weException.Status == WebExceptionStatus.ProtocolError)
// Build up the return value for the caller for this error message.
aRequestResult.SetRequestErrorMessage(iStatusCode, sDescription);
} // End of the catch (WebException weException) statement.
}
