DistrictAPI

All URIs are relative to https://www.thebluealliance.com/api/v3

Method	HTTP request	Description
getDistrictEvents	GET /district/{district_key}/events
getDistrictEventsKeys	GET /district/{district_key}/events/keys
getDistrictEventsSimple	GET /district/{district_key}/events/simple
getDistrictRankings	GET /district/{district_key}/rankings
getDistrictTeams	GET /district/{district_key}/teams
getDistrictTeamsKeys	GET /district/{district_key}/teams/keys
getDistrictTeamsSimple	GET /district/{district_key}/teams/simple
getDistrictsByYear	GET /districts/{year}
getEventDistrictPoints	GET /event/{event_key}/district_points
getTeamDistricts	GET /team/{team_key}/districts

getDistrictEvents

    open class func getDistrictEvents(districtKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [Event]?, _ error: Error?) -> Void)

Gets a list of events in the given district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let districtKey = "districtKey_example" // String | TBA District Key, eg `2016fim`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictEvents(districtKey: districtKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[Event]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictEventsKeys

    open class func getDistrictEventsKeys(districtKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [String]?, _ error: Error?) -> Void)

Gets a list of event keys for events in the given district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let districtKey = "districtKey_example" // String | TBA District Key, eg `2016fim`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictEventsKeys(districtKey: districtKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[String]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictEventsSimple

    open class func getDistrictEventsSimple(districtKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [EventSimple]?, _ error: Error?) -> Void)

Gets a short-form list of events in the given district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let districtKey = "districtKey_example" // String | TBA District Key, eg `2016fim`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictEventsSimple(districtKey: districtKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[EventSimple]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictRankings

    open class func getDistrictRankings(districtKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [DistrictRanking]?, _ error: Error?) -> Void)

Gets a list of team district rankings for the given district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let districtKey = "districtKey_example" // String | TBA District Key, eg `2016fim`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictRankings(districtKey: districtKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[DistrictRanking]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictTeams

    open class func getDistrictTeams(districtKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [Team]?, _ error: Error?) -> Void)

Gets a list of Team objects that competed in events in the given district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let districtKey = "districtKey_example" // String | TBA District Key, eg `2016fim`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictTeams(districtKey: districtKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[Team]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictTeamsKeys

    open class func getDistrictTeamsKeys(districtKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [String]?, _ error: Error?) -> Void)

Gets a list of Team objects that competed in events in the given district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let districtKey = "districtKey_example" // String | TBA District Key, eg `2016fim`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictTeamsKeys(districtKey: districtKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[String]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictTeamsSimple

    open class func getDistrictTeamsSimple(districtKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [TeamSimple]?, _ error: Error?) -> Void)

Gets a short-form list of Team objects that competed in events in the given district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let districtKey = "districtKey_example" // String | TBA District Key, eg `2016fim`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictTeamsSimple(districtKey: districtKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[TeamSimple]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictsByYear

    open class func getDistrictsByYear(year: Int, ifModifiedSince: String? = nil, completion: @escaping (_ data: [DistrictList]?, _ error: Error?) -> Void)

Gets a list of districts and their corresponding district key, for the given year.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let year = 987 // Int | Competition Year (or Season). Must be 4 digits.
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getDistrictsByYear(year: year, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
year	Int	Competition Year (or Season). Must be 4 digits.
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[DistrictList]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEventDistrictPoints

    open class func getEventDistrictPoints(eventKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: EventDistrictPoints?, _ error: Error?) -> Void)

Gets a list of team rankings for the Event.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let eventKey = "eventKey_example" // String | TBA Event Key, eg `2016nytr`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getEventDistrictPoints(eventKey: eventKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg `2016nytr`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

EventDistrictPoints

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamDistricts

    open class func getTeamDistricts(teamKey: String, ifModifiedSince: String? = nil, completion: @escaping (_ data: [DistrictList]?, _ error: Error?) -> Void)

Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import TBAAPIv3Kit

let teamKey = "teamKey_example" // String | TBA Team Key, eg `frc254`
let ifModifiedSince = "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)

DistrictAPI.getTeamDistricts(teamKey: teamKey, ifModifiedSince: ifModifiedSince) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[DistrictList]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DistrictAPI.md

Latest commit

History

DistrictAPI.md

File metadata and controls

DistrictAPI

getDistrictEvents

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictEventsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictEventsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictRankings

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeams

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictsByYear

Example

Parameters

Return type

Authorization

HTTP request headers

getEventDistrictPoints

Example

Parameters

Return type

Authorization

HTTP request headers

getTeamDistricts

Example

Parameters

Return type

Authorization

HTTP request headers