com.thebluealliance.api.v3.requests

Class APIResponse

java.lang.Object

com.thebluealliance.api.v3.requests.APIResponse

public class APIResponse
extends java.lang.Object

Holds a response from The Blue Alliance API com.thebluealliance.api.v3

Constructor Summary

Constructors

Constructor and Description
APIResponse(java.lang.String jsonContent, java.lang.String lastModified, int responseCode) Creates an APIResponse object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getJson()
java.lang.String	getLastModified()
int	getResponseCode()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

APIResponse

public APIResponse(java.lang.String jsonContent,
                   java.lang.String lastModified,
                   int responseCode)

Creates an APIResponse object

Parameters:

jsonContent - JSON data returned by the API

lastModified - The Last-Modified response header

responseCode - The HTTP response code

Method Detail

getJson

public java.lang.String getJson()

Returns:

The JSON string returned by the API. May be null if the responseCode is not 200.

getLastModified

public java.lang.String getLastModified()

Returns:

The date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

getResponseCode

public int getResponseCode()

Returns:

The HTTP response code given by the API. Value is 200 if the response is successful, 304 if data was not modified and the If-Modified-Since header is used, 401 if no TBA com.thebluealliance.api.v3 API Key was provided, or it is not valid, or 404 if the URL or parameter(s) provided is invalid