SportsEngine API

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/sports"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/sports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/sports")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

[
    {
        "id": 1,
        "name": "Ice Hockey",
        "updated_on": "2011-11-17T04:49:23-08:00",
        "created_on": "2006-11-29T00:58:07-08:00",
        "class_name": "IceHockey",
        "stat_enabled": true,
        "tabular_scoring_plays": true
    },
    {
        "id": 3,
        "name": "Lacrosse",
        "updated_on": "2011-12-18T16:24:56-08:00",
        "created_on": "2006-12-07T18:22:25-08:00",
        "class_name": "Lacrosse",
        "stat_enabled": true,
        "tabular_scoring_plays": true
    },
    {
        "id": 4,
        "name": "Baseball/Softball",
        "updated_on": "2012-03-23T01:32:25-07:00",
        "created_on": "2006-12-07T18:22:38-08:00",
        "class_name": "Baseball",
        "stat_enabled": true,
        "tabular_scoring_plays": false
    },
    {
        "id": 5,
        "name": "Soccer",
        "updated_on": "2012-07-17T22:43:03-07:00",
        "created_on": "2006-12-07T18:22:54-08:00",
        "class_name": "Soccer",
        "stat_enabled": true,
        "tabular_scoring_plays": true
    },
    {
        "id": 6,
        "name": "Cycling",
        "updated_on": "2006-12-15T17:06:35-08:00",
        "created_on": "2006-12-15T17:06:35-08:00",
        "class_name": "Cycling",
        "stat_enabled": null,
        "tabular_scoring_plays": false
    },
    {
        "id": 7,
        "name": "Basketball",
        "updated_on": "2012-07-03T22:22:09-07:00",
        "created_on": "2006-12-20T15:11:13-08:00",
        "class_name": "Basketball",
        "stat_enabled": true,
        "tabular_scoring_plays": false
    },
    {
        "id": 9,
        "name": "Track and Field",
        "updated_on": "2006-12-28T12:32:21-08:00",
        "created_on": "2006-12-28T12:32:21-08:00",
        "class_name": "TrackAndField",
        "stat_enabled": null,
        "tabular_scoring_plays": false
    },
    {
        "id": 10,
        "name": "Tennis",
        "updated_on": "2007-01-25T16:20:28-08:00",
        "created_on": "2007-01-25T16:20:28-08:00",
        "class_name": "Tennis",
        "stat_enabled": null,
        "tabular_scoring_plays": false
    },
    {
        "id": 11,
        "name": "Football",
        "updated_on": "2011-08-03T22:00:45-07:00",
        "created_on": "2007-04-04T16:41:25-07:00",
        "class_name": "Football",
        "stat_enabled": true,
        "tabular_scoring_plays": true
    },
    {
        "id": 12,
        "name": "Volleyball",
        "updated_on": "2011-08-18T13:25:07-07:00",
        "created_on": "2007-10-12T11:34:32-07:00",
        "class_name": "Volleyball",
        "stat_enabled": true,
        "tabular_scoring_plays": false
    },
    {
        "id": 13,
        "name": "Wrestling",
        "updated_on": "2008-01-08T12:52:23-08:00",
        "created_on": "2008-01-08T12:52:23-08:00",
        "class_name": "Wrestling",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 16,
        "name": "Rugby Union",
        "updated_on": "2010-03-02T06:40:46-08:00",
        "created_on": "2010-03-02T06:40:46-08:00",
        "class_name": "RugbyUnion",
        "stat_enabled": true,
        "tabular_scoring_plays": false
    },
    {
        "id": 18,
        "name": "Golf",
        "updated_on": "2011-03-15T07:12:07-07:00",
        "created_on": "2011-03-15T07:12:07-07:00",
        "class_name": "Golf",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 20,
        "name": "Paintball",
        "updated_on": "2012-04-28T16:57:19-07:00",
        "created_on": "2012-04-28T16:57:19-07:00",
        "class_name": "Paintball",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 21,
        "name": "Cross Country",
        "updated_on": "2012-05-11T08:01:00-07:00",
        "created_on": "2012-05-11T08:01:00-07:00",
        "class_name": "CrossCountry",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 22,
        "name": "Swimming",
        "updated_on": "2012-05-11T08:01:16-07:00",
        "created_on": "2012-05-11T08:01:16-07:00",
        "class_name": "Swimming",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 23,
        "name": "Skiing",
        "updated_on": "2012-05-23T12:21:27-07:00",
        "created_on": "2012-05-23T12:21:27-07:00",
        "class_name": "Skiing",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 24,
        "name": "Basic",
        "updated_on": "2012-08-14T13:08:29-07:00",
        "created_on": "2012-08-14T13:08:29-07:00",
        "class_name": "Basic",
        "stat_enabled": true,
        "tabular_scoring_plays": false
    },
    {
        "id": 25,
        "name": "Rugby wheel chair",
        "updated_on": "2013-01-22T10:59:44-08:00",
        "created_on": "2013-01-22T10:59:44-08:00",
        "class_name": "Wheelchair",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 26,
        "name": "Canadian Football",
        "updated_on": "2014-06-27T10:15:32-07:00",
        "created_on": "2014-06-27T10:15:32-07:00",
        "class_name": "CanadianFootball",
        "stat_enabled": true,
        "tabular_scoring_plays": true
    },
    {
        "id": 27,
        "name": "Other",
        "updated_on": "2015-08-19T19:41:54-07:00",
        "created_on": "2015-08-19T19:41:54-07:00",
        "class_name": "",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    },
    {
        "id": 28,
        "name": "Water Polo",
        "updated_on": "2015-10-22T13:41:01-07:00",
        "created_on": "2015-10-22T13:41:01-07:00",
        "class_name": "",
        "stat_enabled": false,
        "tabular_scoring_plays": false
    }
]

{"_id":"57110c3f999cb92b00a1fa88","__v":0,"excerpt":"The Show method returns a single Sport for a given `id`.\n\n###Parameters","isReference":true,"type":"get","body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"1-0\": \"name\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Sport name\",\n    \"0-2\": \"Sport id assigned by NGIN\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Notes\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","category":"56e857b6c59c4a0e00d5d052","link_external":false,"parentDoc":null,"slug":"sports-show","updates":[],"version":"56cca51eca43550b002813fa","api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/sports/1\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/sports/1\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/sports/1\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"_id":"57110c3f999cb92b00a1fa89","default":"","desc":"Id of the sport to display","name":"id","ref":"","required":true,"type":"int","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 1,\n    \"name\": \"Ice Hockey\",\n    \"updated_on\": \"2011-11-17T04:49:23-08:00\",\n    \"created_on\": \"2006-11-29T00:58:07-08:00\",\n    \"class_name\": \"IceHockey\",\n    \"stat_enabled\": true,\n    \"tabular_scoring_plays\": true\n}","name":""}]},"settings":"","url":"/sports/:id","auth":"required"},"createdAt":"2016-04-15T15:43:59.246Z","editedParams":true,"title":"Sports Show","user":"56548c568975c70d002ea4b4","sync_unique":"","editedParams2":true,"githubsync":"","hidden":false,"link_url":"","order":2,"project":"5641217e0ee5370d00da636d","childrenPages":[]}

getSports Show

The Show method returns a single Sport for a given `id`. ###Parameters

Path Params

id:

required

integer

Id of the sport to display

Attributes

Attribute

Type

Notes

Integer

Sport id assigned by NGIN

name

String

Sport name

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/sports/1"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/sports/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/sports/1")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1,
    "name": "Ice Hockey",
    "updated_on": "2011-11-17T04:49:23-08:00",
    "created_on": "2006-11-29T00:58:07-08:00",
    "class_name": "IceHockey",
    "stat_enabled": true,
    "tabular_scoring_plays": true
}

{"_id":"57014b649433720e00080da2","title":"Officials","user":"56cbf1419f4ae20b00644fde","version":"56cca51eca43550b002813fa","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]}},"hidden":false,"link_external":false,"order":3,"slug":"officials","project":"5641217e0ee5370d00da636d","type":"basic","body":"","githubsync":"","isReference":true,"link_url":"","updates":[],"sync_unique":"","__v":9,"category":"56e857b6c59c4a0e00d5d052","createdAt":"2016-04-03T16:57:08.662Z","excerpt":"Officials are the referees for a particular [Game](https://sportnginv2.readme.io/docs/games-show).\n\n###Associations\nA Official belongs to a [Game](https://sportnginv2.readme.io/docs/games-show) and is classified by [Official Types](https://sportnginv2.readme.io/docs/official-types-show).  [Official Type](https://sportnginv2.readme.io/docs/official-types-show) is germane to a given [Sports](https://sportnginv2.readme.io/docs/sports).","parentDoc":null,"childrenPages":[]}

Officials

Officials are the referees for a particular [Game](https://sportnginv2.readme.io/docs/games-show). ###Associations A Official belongs to a [Game](https://sportnginv2.readme.io/docs/games-show) and is classified by [Official Types](https://sportnginv2.readme.io/docs/official-types-show). [Official Type](https://sportnginv2.readme.io/docs/official-types-show) is germane to a given [Sports](https://sportnginv2.readme.io/docs/sports).

{"_id":"56f1a788da0c573400bacd0e","updates":[],"body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attributes\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"game_id\",\n    \"0-1\": \"Integer\",\n    \"1-0\": \"initial_state\",\n    \"1-1\": \"Integer\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"56e857b6c59c4a0e00d5d052","excerpt":"The Index method returns an array of Officials matching the given parameters.\n\n###Parameters","isReference":true,"sync_unique":"","title":"Officials Index","version":"56cca51eca43550b002813fa","__v":0,"api":{"settings":"","url":"/officials","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/officials?game_id=13557134\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/officials?game_id=13557134\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/officials?game_id=13557134\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"default":"","desc":"","name":"game_id","ref":"","required":true,"type":"int","in":"query","_id":"56f1a788da0c573400bacd0f"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"id\": 193702,\n        \"name\": \"Joe the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134,\n        \"created_at\": \"2016-04-08T11:53:36-07:00\",\n        \"updated_at\": \"2016-04-08T11:53:36-07:00\"\n    },\n    {\n        \"id\": 193703,\n        \"name\": \"Jane the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134,\n        \"created_at\": \"2016-04-08T12:26:27-07:00\",\n        \"updated_at\": \"2016-04-08T12:26:27-07:00\"\n    }\n]","name":""}]}},"githubsync":"","hidden":false,"link_url":"","project":"5641217e0ee5370d00da636d","createdAt":"2016-03-22T20:14:00.250Z","slug":"officials-index","type":"get","user":"56e71f9edee212320019e731","editedParams":true,"editedParams2":true,"link_external":false,"order":4,"parentDoc":null,"childrenPages":[]}

getOfficials Index

The Index method returns an array of Officials matching the given parameters. ###Parameters

Query Params

game_id:

required

integer

Attributes

Type

game_id

Integer

initial_state

Integer

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/officials?game_id=13557134"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/officials?game_id=13557134")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/officials?game_id=13557134")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

[
    {
        "id": 193702,
        "name": "Joe the Ref",
        "official_type_id": 1,
        "game_id": 13557134,
        "created_at": "2016-04-08T11:53:36-07:00",
        "updated_at": "2016-04-08T11:53:36-07:00"
    },
    {
        "id": 193703,
        "name": "Jane the Ref",
        "official_type_id": 1,
        "game_id": 13557134,
        "created_at": "2016-04-08T12:26:27-07:00",
        "updated_at": "2016-04-08T12:26:27-07:00"
    }
]

{"_id":"56f1a8223eb62a34003ea01a","project":"5641217e0ee5370d00da636d","createdAt":"2016-03-22T20:16:34.087Z","order":5,"isReference":true,"link_external":false,"slug":"officials-create","version":"56cca51eca43550b002813fa","excerpt":"The Create method accepts a single Official (see attributes above) and creates a new record in SportsEngine.\n\n###Parameters","githubsync":"","hidden":false,"link_url":"","title":"Officials Create","type":"post","updates":[],"editedParams2":true,"body":"","category":"56e857b6c59c4a0e00d5d052","editedParams":true,"parentDoc":null,"sync_unique":"","user":"56e71f9edee212320019e731","__v":2,"api":{"params":[{"name":"name","in":"body","_id":"56f1a8223eb62a34003ea01b","ref":"","required":true,"desc":"Name of the official","default":"","type":"string"},{"desc":"ID of the game the official will be assigned to","default":"","type":"int","name":"game_id","in":"body","_id":"570806d8eec9610e003ebddd","ref":"","required":true},{"ref":"","required":false,"desc":"ID representing the type of official to be created","default":"","type":"int","name":"official_type_id","in":"body","_id":"570806d8eec9610e003ebdde"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 193703,\n    \"name\": \"Jane the Ref\",\n    \"official_type_id\": 1,\n    \"game_id\": 13557134,\n    \"created_at\": \"2016-04-08T12:26:27-07:00\",\n    \"updated_at\": \"2016-04-08T12:26:27-07:00\"\n}","name":""}]},"settings":"","url":"/officials","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n    \"official\":{\n        \"name\": \"Jane the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134\n    }\n}' \"https://api.sportngin.com/officials\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/officials\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"official\\\":{\\n        \\\"name\\\": \\\"Jane the Ref\\\",\\n        \\\"official_type_id\\\": 1,\\n        \\\"game_id\\\": 13557134\\n    }\\n}\"\n\nresponse = http.request(request)\nputs response.read_body"},{"code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"official\\\":{\\n        \\\"name\\\": \\\"Jane the Ref\\\",\\n        \\\"official_type_id\\\": 1,\\n        \\\"game_id\\\": 13557134\\n    }\\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/officials\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"}]},"method":"post"},"childrenPages":[]}

postOfficials Create

The Create method accepts a single Official (see attributes above) and creates a new record in SportsEngine. ###Parameters

Body Params

name:

required

string

Name of the official

game_id:

required

integer

ID of the game the official will be assigned to

official_type_id:

integer

ID representing the type of official to be created

Definition

Examples

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
    "official":{
        "name": "Jane the Ref",
        "official_type_id": 1,
        "game_id": 13557134
    }
}' "https://api.sportngin.com/officials"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/officials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"official\":{\n        \"name\": \"Jane the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134\n    }\n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"official\":{\n        \"name\": \"Jane the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134\n    }\n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/officials")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 193703,
    "name": "Jane the Ref",
    "official_type_id": 1,
    "game_id": 13557134,
    "created_at": "2016-04-08T12:26:27-07:00",
    "updated_at": "2016-04-08T12:26:27-07:00"
}

{"_id":"56f1a99161376720009412ab","isReference":true,"project":"5641217e0ee5370d00da636d","user":"56e71f9edee212320019e731","api":{"params":[{"type":"int","in":"body","_id":"56f1a99161376720009412ac","default":"","desc":"","name":"current_user","ref":"","required":true}],"results":{"codes":[{"language":"json","code":"{\n    \"id\": 193705,\n    \"name\": \"Jill the Ref\",\n    \"official_type_id\": 1,\n    \"game_id\": 13557134,\n    \"created_at\": \"2016-04-08T13:33:40-07:00\",\n    \"updated_at\": \"2016-04-08T13:33:40-07:00\"\n}","name":"","status":200}]},"settings":"","url":"/officials","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Content-Type: application/json\" -H \"NGIN-API-VERSION: 0.1\" -d '{\n    \"id\": \"193703\",\n    \"official\":{\n        \"name\": \"Jill the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134\n    }\n}' \"https://api.sportngin.com/officials\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/officials\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"content-type\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest.body = \"{\\n    \\\"id\\\": \\\"193703\\\",\\n    \\\"official\\\":{\\n        \\\"name\\\": \\\"Jill the Ref\\\",\\n        \\\"official_type_id\\\": 1,\\n        \\\"game_id\\\": 13557134\\n    }\\n}\"\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"id\\\": \\\"193703\\\",\\n    \\\"official\\\":{\\n        \\\"name\\\": \\\"Jill the Ref\\\",\\n        \\\"official_type_id\\\": 1,\\n        \\\"game_id\\\": 13557134\\n    }\\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/officials\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"content-type\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"post"},"category":"56e857b6c59c4a0e00d5d052","editedParams2":true,"hidden":false,"parentDoc":null,"sync_unique":"","title":"Officials Update","body":"","editedParams":true,"githubsync":"","order":6,"link_external":false,"link_url":"","slug":"officials-update","type":"post","__v":0,"createdAt":"2016-03-22T20:22:41.830Z","excerpt":"The Update method accepts a single Official (see attributes above) and updates the matching record in SportsEngine.\n\n###Parameters","updates":[],"version":"56cca51eca43550b002813fa","childrenPages":[]}

postOfficials Update

The Update method accepts a single Official (see attributes above) and updates the matching record in SportsEngine. ###Parameters

Body Params

current_user:

required

integer

Definition

Examples

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" -H "Content-Type: application/json" -H "NGIN-API-VERSION: 0.1" -d '{
    "id": "193703",
    "official":{
        "name": "Jill the Ref",
        "official_type_id": 1,
        "game_id": 13557134
    }
}' "https://api.sportngin.com/officials"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/officials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["content-type"] = 'application/json'
request["ngin-api-version"] = '0.1'
request.body = "{\n    \"id\": \"193703\",\n    \"official\":{\n        \"name\": \"Jill the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134\n    }\n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"id\": \"193703\",\n    \"official\":{\n        \"name\": \"Jill the Ref\",\n        \"official_type_id\": 1,\n        \"game_id\": 13557134\n    }\n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/officials")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("content-type", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 193705,
    "name": "Jill the Ref",
    "official_type_id": 1,
    "game_id": 13557134,
    "created_at": "2016-04-08T13:33:40-07:00",
    "updated_at": "2016-04-08T13:33:40-07:00"
}

{"_id":"56f1a6184476fb2200795e5b","project":"5641217e0ee5370d00da636d","user":"56e71f9edee212320019e731","version":"56cca51eca43550b002813fa","editedParams":true,"editedParams2":true,"link_url":"","__v":4,"category":"56e857b6c59c4a0e00d5d052","createdAt":"2016-03-22T20:07:52.496Z","hidden":false,"title":"Official Types Show","type":"get","body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attributes\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Unique id assign by NGIN\",\n    \"1-0\": \"name\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Name of the official type\",\n    \"2-0\": \"sport_id\",\n    \"2-1\": \"Integer\",\n    \"2-2\": \"ID of the sport assigned by NGIN\",\n    \"3-0\": \"created_at\",\n    \"3-1\": \"Datetime\",\n    \"3-2\": \"Timestamp of creation date\",\n    \"4-0\": \"updated_at\",\n    \"4-1\": \"Datetime\",\n    \"4-2\": \"Timestamp of last update\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","githubsync":"","isReference":true,"sync_unique":"","parentDoc":null,"slug":"official-types-show","updates":[],"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/official_types/?sport_id=1\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/official_types/?sport_id=1\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/official_types/?sport_id=1\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"type":"int","in":"query","_id":"56fd51fed393740e0080f29c","default":"","desc":"","name":"sport_id","ref":"","required":true}],"results":{"codes":[{"language":"json","code":"[\n    {\n        \"created_at\": \"2011-08-03T21:54:13-07:00\",\n        \"id\": 1,\n        \"name\": \"Official\",\n        \"sport_id\": 1,\n        \"updated_at\": \"2011-08-03T21:54:13-07:00\"\n    },\n    {\n        \"created_at\": \"2011-08-03T21:54:13-07:00\",\n        \"id\": 17,\n        \"name\": \"Referee\",\n        \"sport_id\": 1,\n        \"updated_at\": \"2011-08-03T21:54:13-07:00\"\n    },\n    {\n        \"created_at\": \"2011-08-03T21:54:13-07:00\",\n        \"id\": 18,\n        \"name\": \"Linesman\",\n        \"sport_id\": 1,\n        \"updated_at\": \"2011-08-03T21:54:13-07:00\"\n    },\n    {\n        \"created_at\": \"2011-08-03T21:54:13-07:00\",\n        \"id\": 19,\n        \"name\": \"Assistant Referee\",\n        \"sport_id\": 1,\n        \"updated_at\": \"2011-08-03T21:54:13-07:00\"\n    },\n    {\n        \"created_at\": \"2011-08-03T21:54:13-07:00\",\n        \"id\": 34,\n        \"name\": \"Other\",\n        \"sport_id\": 1,\n        \"updated_at\": \"2011-08-03T21:54:13-07:00\"\n    },\n    {\n        \"created_at\": \"2012-10-05T12:23:54-07:00\",\n        \"id\": 54,\n        \"name\": \"Official Scorer\",\n        \"sport_id\": 1,\n        \"updated_at\": \"2012-10-05T12:23:54-07:00\"\n    },\n    {\n        \"created_at\": \"2012-10-05T12:23:54-07:00\",\n        \"id\": 55,\n        \"name\": \"Score Keeper\",\n        \"sport_id\": 1,\n        \"updated_at\": \"2012-10-05T12:23:54-07:00\"\n    }\n]","name":"","status":200}]},"settings":"","url":"/official_types","auth":"required"},"excerpt":"The Show method returns an array of Official Types for a given `sport_id`.\n\n###Parameters","link_external":false,"order":8,"childrenPages":[]}

getOfficial Types Show

The Show method returns an array of Official Types for a given `sport_id`. ###Parameters

Query Params

sport_id:

required

integer

Attributes

Type

Notes

Integer

Unique id assign by NGIN

name

String

Name of the official type

sport_id

Integer

ID of the sport assigned by NGIN

created_at

Datetime

Timestamp of creation date

updated_at

Datetime

Timestamp of last update

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/official_types/?sport_id=1"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/official_types/?sport_id=1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/official_types/?sport_id=1")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

[
    {
        "created_at": "2011-08-03T21:54:13-07:00",
        "id": 1,
        "name": "Official",
        "sport_id": 1,
        "updated_at": "2011-08-03T21:54:13-07:00"
    },
    {
        "created_at": "2011-08-03T21:54:13-07:00",
        "id": 17,
        "name": "Referee",
        "sport_id": 1,
        "updated_at": "2011-08-03T21:54:13-07:00"
    },
    {
        "created_at": "2011-08-03T21:54:13-07:00",
        "id": 18,
        "name": "Linesman",
        "sport_id": 1,
        "updated_at": "2011-08-03T21:54:13-07:00"
    },
    {
        "created_at": "2011-08-03T21:54:13-07:00",
        "id": 19,
        "name": "Assistant Referee",
        "sport_id": 1,
        "updated_at": "2011-08-03T21:54:13-07:00"
    },
    {
        "created_at": "2011-08-03T21:54:13-07:00",
        "id": 34,
        "name": "Other",
        "sport_id": 1,
        "updated_at": "2011-08-03T21:54:13-07:00"
    },
    {
        "created_at": "2012-10-05T12:23:54-07:00",
        "id": 54,
        "name": "Official Scorer",
        "sport_id": 1,
        "updated_at": "2012-10-05T12:23:54-07:00"
    },
    {
        "created_at": "2012-10-05T12:23:54-07:00",
        "id": 55,
        "name": "Score Keeper",
        "sport_id": 1,
        "updated_at": "2012-10-05T12:23:54-07:00"
    }
]

{"_id":"570142c5a565e20e00157415","order":0,"type":"basic","version":"56cca51eca43550b002813fa","isReference":true,"slug":"leagues","updates":[],"hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required","params":[]},"category":"56e03709f97d422900d63922","githubsync":"","link_external":false,"parentDoc":null,"sync_unique":"","__v":17,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Hint\",\n  \"body\": \"A [League Instance](ref:league-instances-index) can inform a [League Instance Tree](ref:league-instance-tree-show), which displays the structure of associated [League Instance](ref:league-instances-index) including dependent [Subseasons](ref:subseasons), [Division Instances Index](doc:division-instances-create), and [Team Instances](ref:team_instances-index).\"\n}\n[/block]","createdAt":"2016-04-03T16:20:21.433Z","excerpt":"A League represents an association of [Teams](https://sportnginv2.readme.io/docs/teams-show) on a [Site](https://sportnginsite.readme.io/docs/sites).  A  is an instance of a specific League, which represents a single [Season](https://sportnginv2.readme.io/docs/seasons-show).\n\nMuch like the League and the [League Instances](https://sportnginv2.readme.io/docs/league-instances-index), a [Team Instance](https://sportnginv2.readme.io/docs/team_instances-show) is an instance of a specific team, usually for a single [Season](https://sportnginv2.readme.io/docs/seasons-show) or [Subseason](https://sportnginv2.readme.io/docs/subseasons-show).  A [Team Instance](https://sportnginv2.readme.io/docs/team_instances-show) belongs to a [Rosters Index](https://sportnginv2.readme.io/docs/rosters) or to a [Team](https://sportnginv2.readme.io/docs/teams-show). A [Team Instance](https://sportnginv2.readme.io/docs/team_instances-show) can have many [Photos](https://sportnginsite.readme.io/docs/photo), [Videos](https://sportnginsite.readme.io/docs/video), [Games](https://sportnginv2.readme.io/docs/games-show), and [Subseasons](https://sportnginv2.readme.io/docs/subseasons-show).\n\nA good way to find teams is to use the [Team Finder](https://sportnginv2.readme.io/docs/team-finder-index) endpoint.  The [Team Finder](https://sportnginv2.readme.io/docs/team-finder-index) allows you to search for [Teams](https://sportnginv2.readme.io/docs/teams-show) based on the `team_name`, `site_name`, `site_abbreviation`, and/or `domain_name`.\n\nA [Season](https://sportnginv2.readme.io/docs/seasons-show) is the portion of one year in which the regulated Games of a Sport are in session.\n\nA [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) is a segmented portion of a [Season](https://sportnginv2.readme.io/docs/seasons-show). A [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) could be named the \"Regular Season\", the \"Playoffs,\" or the \"State Tournament.\"\n\n###Associations\nA League has multiple [Divisions](doc:divisions) (which is the actual subgrouping of [Teams](https://sportnginv2.readme.io/docs/teams-show)).  A League has many [League Instances](https://sportnginv2.readme.io/docs/league-instances-index).\n\nA [Divison](doc:divisons-create) is a subgrouping of [Teams](https://sportnginv2.readme.io/docs/teams-index) that belong to a [League](https://sportnginv2.readme.io/docs/leagues). A Division has many [Division Instances](doc:division-instances-index).  A [Division](doc:divisions) also has many [Teams](https://sportnginv2.readme.io/docs/teams-show).\n\nA [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) belongs to a [Season](https://sportnginv2.readme.io/docs/seasons-show), and has many [Team Instances](https://sportnginv2.readme.io/docs/team_instances-show) and [Games](https://sportnginv2.readme.io/docs/games-show).","link_url":"","project":"5641217e0ee5370d00da636d","title":"Leagues","user":"56cbf1419f4ae20b00644fde","childrenPages":[]}

Leagues

A League represents an association of [Teams](https://sportnginv2.readme.io/docs/teams-show) on a [Site](https://sportnginsite.readme.io/docs/sites). A is an instance of a specific League, which represents a single [Season](https://sportnginv2.readme.io/docs/seasons-show). Much like the League and the [League Instances](https://sportnginv2.readme.io/docs/league-instances-index), a [Team Instance](https://sportnginv2.readme.io/docs/team_instances-show) is an instance of a specific team, usually for a single [Season](https://sportnginv2.readme.io/docs/seasons-show) or [Subseason](https://sportnginv2.readme.io/docs/subseasons-show). A [Team Instance](https://sportnginv2.readme.io/docs/team_instances-show) belongs to a [Rosters Index](https://sportnginv2.readme.io/docs/rosters) or to a [Team](https://sportnginv2.readme.io/docs/teams-show). A [Team Instance](https://sportnginv2.readme.io/docs/team_instances-show) can have many [Photos](https://sportnginsite.readme.io/docs/photo), [Videos](https://sportnginsite.readme.io/docs/video), [Games](https://sportnginv2.readme.io/docs/games-show), and [Subseasons](https://sportnginv2.readme.io/docs/subseasons-show). A good way to find teams is to use the [Team Finder](https://sportnginv2.readme.io/docs/team-finder-index) endpoint. The [Team Finder](https://sportnginv2.readme.io/docs/team-finder-index) allows you to search for [Teams](https://sportnginv2.readme.io/docs/teams-show) based on the `team_name`, `site_name`, `site_abbreviation`, and/or `domain_name`. A [Season](https://sportnginv2.readme.io/docs/seasons-show) is the portion of one year in which the regulated Games of a Sport are in session. A [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) is a segmented portion of a [Season](https://sportnginv2.readme.io/docs/seasons-show). A [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) could be named the "Regular Season", the "Playoffs," or the "State Tournament." ###Associations A League has multiple [Divisions](doc:divisions) (which is the actual subgrouping of [Teams](https://sportnginv2.readme.io/docs/teams-show)). A League has many [League Instances](https://sportnginv2.readme.io/docs/league-instances-index). A [Divison](doc:divisons-create) is a subgrouping of [Teams](https://sportnginv2.readme.io/docs/teams-index) that belong to a [League](https://sportnginv2.readme.io/docs/leagues). A Division has many [Division Instances](doc:division-instances-index). A [Division](doc:divisions) also has many [Teams](https://sportnginv2.readme.io/docs/teams-show). A [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) belongs to a [Season](https://sportnginv2.readme.io/docs/seasons-show), and has many [Team Instances](https://sportnginv2.readme.io/docs/team_instances-show) and [Games](https://sportnginv2.readme.io/docs/games-show).

Hint

A League Instance can inform a League Instance Tree, which displays the structure of associated League Instance including dependent Subseasons, Division Instances Index, and Team Instances.

{"_id":"56e037fe5fc52e320024d851","title":"Leagues Index","user":"56548c568975c70d002ea4b4","api":{"examples":{"codes":[{"language":"curl","code":"curl --header \"Authorization: Bearer ACCESS_TOKEN\" --header \"Accept: application/json\" --header \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/leagues?site_id=11953\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/leagues?site_id=11953\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/leagues?site_id=11953\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"name":"site_id","ref":"","required":true,"type":"int","in":"query","_id":"56cf355f5267d70b00494c3a","default":"","desc":"Id of site"},{"name":"site_url","in":"query","_id":"56cf355f5267d70b00494c39","ref":"","required":false,"desc":"Url of site","default":"","type":"string"}],"results":{"codes":[{"code":"[\n    {\n        \"id\": 27737,\n        \"name\": \"Eastern League\",\n        \"current_subseason_id\": 291621,\n        \"site_id\": 11953,\n        \"sport_id\": 1,\n        \"image_id\": null,\n        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n        \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n        \"button_title\": \"Eastern\",\n        \"primary_color\": \"00AEEF\",\n        \"secondary_color\": \"666666\",\n        \"gender\": \"male\",\n        \"abbrev\": \"East\",\n        \"score_ribbon\": false,\n        \"tweet_games\": null,\n        \"game_sheet_label\": \"gamesheet\"\n    },\n    {\n        \"id\": 27738,\n        \"name\": \"Western League\",\n        \"current_subseason_id\": 291622,\n        \"site_id\": 11953,\n        \"sport_id\": 1,\n        \"image_id\": null,\n        \"created_at\": \"2016-03-22T12:48:01-07:00\",\n        \"updated_at\": \"2016-03-24T07:20:41-07:00\",\n        \"button_title\": \"Western\",\n        \"primary_color\": \"00AEEF\",\n        \"secondary_color\": \"666666\",\n        \"gender\": \"male\",\n        \"abbrev\": \"West\",\n        \"score_ribbon\": false,\n        \"tweet_games\": null,\n        \"game_sheet_label\": \"gamesheet\"\n    }\n]","language":"json","status":200,"name":""},{"code":"{\n\t   \"errors\": \"Site not found\"\n}","status":404,"language":"text"}]},"settings":"","url":"/leagues","auth":"required"},"createdAt":"2016-03-09T14:49:34.513Z","editedParams2":true,"excerpt":"The Index method returns an array of Leagues matching the given parameters.\n\nThis endpoint requires at least one parameter, either a `site_id` or a `site_url`.  An error is thrown if any of the parameters are invalid.\n\n###Parameters","slug":"leagues-index","body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"name\",\n    \"2-0\": \"current_subseason_id\",\n    \"3-0\": \"site_id\",\n    \"4-0\": \"sport_id\",\n    \"5-0\": \"image_id\",\n    \"6-0\": \"created_at\",\n    \"7-0\": \"updated_at\",\n    \"8-0\": \"button_title\",\n    \"9-0\": \"primary_color\",\n    \"10-0\": \"secondary_color\",\n    \"11-0\": \"gender\",\n    \"12-0\": \"abbrev\",\n    \"13-0\": \"score_ribbon\",\n    \"14-0\": \"tweet_games\",\n    \"15-0\": \"game_sheet_label\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"String\",\n    \"2-1\": \"Integer\",\n    \"3-1\": \"Integer\",\n    \"4-1\": \"Integer\",\n    \"5-1\": \"Integer\",\n    \"6-1\": \"Timestamp\",\n    \"7-1\": \"Timestamp\",\n    \"8-1\": \"String\",\n    \"9-1\": \"String\",\n    \"10-1\": \"String\",\n    \"11-1\": \"String\",\n    \"12-1\": \"String\",\n    \"13-1\": \"Boolean\",\n    \"14-1\": \"Boolean\",\n    \"15-1\": \"String\",\n    \"0-2\": \"ID of league\",\n    \"1-2\": \"Name of league\",\n    \"2-2\": \"ID of the current subseason for the league. This could also be defined as the \\\"default\\\" subseason.\",\n    \"3-2\": \"ID of the site that the league belongs to\",\n    \"4-2\": \"ID of the sport that the league plays\",\n    \"5-2\": \"ID of an image\",\n    \"6-2\": \"Timestamp when created\",\n    \"7-2\": \"Timestamp of last update\",\n    \"8-2\": \"Title of league that shows up in navigation\",\n    \"9-2\": \"Primary color used in styling of league pages\",\n    \"10-2\": \"Secondary color used in styling of league pages\",\n    \"11-2\": \"Gender of league\",\n    \"12-2\": \"Abbreviation of league. Used in various locations that have limited text.\",\n    \"13-2\": \"Display score ribbon on league page\",\n    \"14-2\": \"Tweet games for league\",\n    \"15-2\": \"League's label for game sheets. Possible values are \\\"gamesheet\\\" or \\\"boxscore\\\".\"\n  },\n  \"cols\": 3,\n  \"rows\": 16\n}\n[/block]","order":1,"type":"get","updates":[],"__v":0,"githubsync":"","hidden":false,"link_url":"","sync_unique":"","parentDoc":null,"project":"5641217e0ee5370d00da636d","version":"56cca51eca43550b002813fa","category":"56e03709f97d422900d63922","editedParams":true,"isReference":true,"link_external":false,"childrenPages":[]}

getLeagues Index

The Index method returns an array of Leagues matching the given parameters. This endpoint requires at least one parameter, either a `site_id` or a `site_url`. An error is thrown if any of the parameters are invalid. ###Parameters

Query Params

site_id:

required

integer

Id of site

site_url:

string

Url of site

Attributes

Name

Type

Description

Integer

ID of league

name

String

Name of league

current_subseason_id

Integer

ID of the current subseason for the league. This could also be defined as the "default" subseason.

site_id

Integer

ID of the site that the league belongs to

sport_id

Integer

ID of the sport that the league plays

image_id

Integer

ID of an image

created_at

Timestamp

Timestamp when created

updated_at

Timestamp

Timestamp of last update

button_title

String

Title of league that shows up in navigation

primary_color

String

Primary color used in styling of league pages

secondary_color

String

Secondary color used in styling of league pages

gender

String

Gender of league

abbrev

String

Abbreviation of league. Used in various locations that have limited text.

score_ribbon

Boolean

Display score ribbon on league page

tweet_games

Boolean

Tweet games for league

game_sheet_label

String

League's label for game sheets. Possible values are "gamesheet" or "boxscore".

Definition

Examples

curl --header "Authorization: Bearer ACCESS_TOKEN" --header "Accept: application/json" --header "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/leagues?site_id=11953"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/leagues?site_id=11953")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/leagues?site_id=11953")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

404 Not Found

[
    {
        "id": 27737,
        "name": "Eastern League",
        "current_subseason_id": 291621,
        "site_id": 11953,
        "sport_id": 1,
        "image_id": null,
        "created_at": "2016-03-22T12:46:58-07:00",
        "updated_at": "2016-03-24T07:20:49-07:00",
        "button_title": "Eastern",
        "primary_color": "00AEEF",
        "secondary_color": "666666",
        "gender": "male",
        "abbrev": "East",
        "score_ribbon": false,
        "tweet_games": null,
        "game_sheet_label": "gamesheet"
    },
    {
        "id": 27738,
        "name": "Western League",
        "current_subseason_id": 291622,
        "site_id": 11953,
        "sport_id": 1,
        "image_id": null,
        "created_at": "2016-03-22T12:48:01-07:00",
        "updated_at": "2016-03-24T07:20:41-07:00",
        "button_title": "Western",
        "primary_color": "00AEEF",
        "secondary_color": "666666",
        "gender": "male",
        "abbrev": "West",
        "score_ribbon": false,
        "tweet_games": null,
        "game_sheet_label": "gamesheet"
    }
]

{
	   "errors": "Site not found"
}

{"_id":"56cf47d2336aa60b0086a224","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/leagues/27737\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/leagues/27737\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/leagues/27737\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"_id":"56cf47d2336aa60b0086a225","default":"","desc":"Id of the League","name":"id","ref":"","required":true,"type":"int","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"id\": 27737,\n    \"name\": \"Eastern League\",\n    \"current_subseason_id\": 291621,\n    \"site_id\": 11953,\n    \"sport_id\": 1,\n    \"image_id\": null,\n    \"created_at\": \"2016-03-22T12:46:58-07:00\",\n    \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n    \"button_title\": \"Eastern\",\n    \"primary_color\": \"00AEEF\",\n    \"secondary_color\": \"666666\",\n    \"gender\": \"male\",\n    \"abbrev\": \"East\",\n    \"score_ribbon\": false,\n    \"tweet_games\": null,\n    \"game_sheet_label\": \"gamesheet\"\n}","language":"json","status":200}]},"settings":"","url":"/leagues/:id"},"createdAt":"2016-02-25T18:28:34.751Z","link_external":false,"project":"5641217e0ee5370d00da636d","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Hint\",\n  \"body\": \"This endpoint is useful when there are many leagues in a [Site](ref:sites).  However, since the League Index endpoint returns the full League document in the results array, the League Index endpoint is sufficient most of the time.\"\n}\n[/block]","editedParams2":true,"githubsync":"","hidden":false,"order":2,"sync_unique":"","updates":[],"isReference":true,"link_url":"","type":"get","user":"569e96c56b4a2c0d007e9153","__v":0,"category":"56e03709f97d422900d63922","editedParams":true,"excerpt":"The Show method returns a single League for a given `id`.\n\n###Parameters","parentDoc":null,"slug":"leagues-show","title":"Leagues Show","version":"56cca51eca43550b002813fa","childrenPages":[]}

getLeagues Show

The Show method returns a single League for a given `id`. ###Parameters

Path Params

id:

required

integer

Id of the League

Hint

This endpoint is useful when there are many leagues in a Site. However, since the League Index endpoint returns the full League document in the results array, the League Index endpoint is sufficient most of the time.

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/leagues/27737"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/leagues/27737")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/leagues/27737")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 27737,
    "name": "Eastern League",
    "current_subseason_id": 291621,
    "site_id": 11953,
    "sport_id": 1,
    "image_id": null,
    "created_at": "2016-03-22T12:46:58-07:00",
    "updated_at": "2016-03-24T07:20:49-07:00",
    "button_title": "Eastern",
    "primary_color": "00AEEF",
    "secondary_color": "666666",
    "gender": "male",
    "abbrev": "East",
    "score_ribbon": false,
    "tweet_games": null,
    "game_sheet_label": "gamesheet"
}

{"_id":"56e1978e108d6a1700599138","api":{"examples":{"codes":[{"code":"curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/league_instances?league_id=27737\"","language":"curl"},{"code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/league_instances?league_id=27737\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body","language":"ruby"},{"code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/league_instances?league_id=27737\")\n  .get()\n  .addHeader(\"content-type\", \"application/json\")\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"}]},"method":"get","params":[{"name":"league_id","in":"query","_id":"56e197da686c7d200086070b","ref":"","required":true,"desc":"Id of League","default":"","type":"int"}],"results":{"codes":[{"code":"[\n    {\n        \"id\": 41683,\n        \"season_id\": 267440,\n        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n        \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n        \"league_id\": 27737,\n        \"season_name\": \"2016\"\n    }\n]","language":"json","status":200,"name":""},{"name":"","code":"{\n  \"errors\": \"The parameter league_id is required\"\n}","language":"json","status":412}]},"settings":"","url":"/league_instances","auth":"required"},"editedParams":true,"link_external":false,"order":3,"body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"season_id\",\n    \"2-0\": \"created_at\",\n    \"3-0\": \"updated_at\",\n    \"4-0\": \"league_id\",\n    \"5-0\": \"season_name\",\n    \"5-1\": \"String\",\n    \"4-1\": \"Integer\",\n    \"1-1\": \"Integer\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"ID of LeagueInstance\",\n    \"1-2\": \"ID of Season\",\n    \"4-2\": \"ID of League\",\n    \"5-2\": \"Name of Season (derived)\",\n    \"3-1\": \"Timestamp\",\n    \"2-1\": \"Timestamp\",\n    \"2-2\": \"Timestamp when created\",\n    \"3-2\": \"Timestamp of last update\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","editedParams2":true,"excerpt":"The Index method returns an array of League Instances matching the given parameters.\n\n###Parameters","sync_unique":"","user":"569e96c56b4a2c0d007e9153","__v":1,"createdAt":"2016-03-10T15:49:34.919Z","isReference":true,"parentDoc":null,"title":"League Instances Index","updates":[],"version":"56cca51eca43550b002813fa","category":"56e03709f97d422900d63922","githubsync":"","hidden":false,"link_url":"","project":"5641217e0ee5370d00da636d","slug":"league-instances-index","type":"get","childrenPages":[]}

getLeague Instances Index

The Index method returns an array of League Instances matching the given parameters. ###Parameters

Query Params

league_id:

required

integer

Id of League

Attributes

Name

Type

Description

Integer

ID of LeagueInstance

season_id

Integer

ID of Season

created_at

Timestamp

Timestamp when created

updated_at

Timestamp

Timestamp of last update

league_id

Integer

ID of League

season_name

String

Name of Season (derived)

Definition

Examples

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/league_instances?league_id=27737"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/league_instances?league_id=27737")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/league_instances?league_id=27737")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

412 Precondition Failed

[
    {
        "id": 41683,
        "season_id": 267440,
        "created_at": "2016-03-22T12:46:58-07:00",
        "updated_at": "2016-03-22T12:46:58-07:00",
        "league_id": 27737,
        "season_name": "2016"
    }
]

{
  "errors": "The parameter league_id is required"
}

{"_id":"56e1a7db71e22d2b009801e5","type":"get","updates":[],"api":{"settings":"","url":"/league_instance_tree/:id","auth":"required","examples":{"codes":[{"code":"curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/league_instance_tree/41683\"","language":"curl"},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/league_instance_tree/41683\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/league_instance_tree/41683\")\n  .get()\n  .addHeader(\"content-type\", \"application/json\")\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"in":"path","_id":"56e1a7db71e22d2b009801e6","ref":"","required":true,"desc":"Id of LeagueInstance","default":"","type":"int","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"node\": {\n        \"id\": 2458062,\n        \"node_type\": \"LeagueInstance\",\n        \"data\": {\n            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n            \"id\": 41683,\n            \"league_id\": 27737,\n            \"season_id\": 267440,\n            \"updated_at\": \"2016-03-22T12:46:58-07:00\"\n        },\n        \"children\": [\n            {\n                \"node\": {\n                    \"id\": 2458064,\n                    \"node_type\": \"Subseason\",\n                    \"data\": {\n                        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"id\": 291621,\n                        \"name\": \"Regular Season\",\n                        \"position\": 1,\n                        \"season_id\": 267440,\n                        \"snl_scoring_enabled\": true,\n                        \"statistic_grouping_id\": 417884,\n                        \"updated_at\": \"2016-04-11T09:02:40-07:00\",\n                        \"workers_completed\": null,\n                        \"live_scoring_stat_configuration\": {\n                            \"show_plus_minus\": null,\n                            \"fair_play_points\": false\n                        }\n                    },\n                    \"children\": [\n                        {\n                            \"node\": {\n                                \"id\": 2458074,\n                                \"node_type\": \"DivisionInstance\",\n                                \"data\": {\n                                    \"created_at\": \"2016-03-22T12:52:51-07:00\",\n                                    \"division_id\": 66180,\n                                    \"id\": 181552,\n                                    \"max_standings_points\": null,\n                                    \"non_standing\": false,\n                                    \"updated_at\": \"2016-03-22T12:52:51-07:00\",\n                                    \"division\": {\n                                        \"abbrev\": \"Ocn\",\n                                        \"button_title\": \"Oceanic\",\n                                        \"created_at\": \"2016-03-22T12:52:51-07:00\",\n                                        \"id\": 66180,\n                                        \"image_id\": null,\n                                        \"league_id\": 27737,\n                                        \"name\": \"Oceanic Division\",\n                                        \"primary_color\": \"00AEEF\",\n                                        \"secondary_color\": \"666666\",\n                                        \"updated_at\": \"2016-03-22T14:25:05-07:00\"\n                                    }\n                                },\n                                \"children\": [\n                                    {\n                                        \"node\": {\n                                            \"id\": 2458139,\n                                            \"node_type\": \"TeamInstance\",\n                                            \"data\": {\n                                                \"abbrev\": \"Bos\",\n                                                \"affects_standings\": true,\n                                                \"button_title\": \"Boston\",\n                                                \"created_at\": \"2016-03-22T13:19:12-07:00\",\n                                                \"gender\": \"male\",\n                                                \"id\": 1876243,\n                                                \"image_id\": null,\n                                                \"management_team_id\": null,\n                                                \"name\": \"Boston Bears\",\n                                                \"opponent\": null,\n                                                \"parent_team_instance_id\": null,\n                                                \"primary_color\": \"000000\",\n                                                \"roster_id\": 1837158,\n                                                \"secondary_color\": \"000000\",\n                                                \"team_id\": 1373611,\n                                                \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n                                                \"team\": {\n                                                    \"abbrev\": \"Bos\",\n                                                    \"android_whitelabel_url\": null,\n                                                    \"button_title\": \"Boston\",\n                                                    \"created_at\": \"2016-03-22T13:06:41-07:00\",\n                                                    \"gender\": \"male\",\n                                                    \"id\": 1373611,\n                                                    \"image_id\": null,\n                                                    \"ios_whitelabel_url\": null,\n                                                    \"name\": \"Boston Bears\",\n                                                    \"opponent\": null,\n                                                    \"parent_team_id\": null,\n                                                    \"primary_color\": \"000000\",\n                                                    \"secondary_color\": \"000000\",\n                                                    \"sport_id\": 1,\n                                                    \"updated_at\": \"2016-03-23T09:34:28-07:00\"\n                                                }\n                                            },\n                                            \"children\": []\n                                        }\n                                    },\n                                  ...","name":""}]}},"editedParams":true,"hidden":false,"order":4,"parentDoc":null,"category":"56e03709f97d422900d63922","excerpt":"The Show method returns the page node structure beneath the [League Instance](https://sportnginv2.readme.io/docs/league-instances-index).\n\n###Parameters","link_url":"","title":"League Instance Tree Show","user":"569e96c56b4a2c0d007e9153","editedParams2":true,"githubsync":"","isReference":true,"createdAt":"2016-03-10T16:59:07.252Z","link_external":false,"project":"5641217e0ee5370d00da636d","slug":"league-instance-tree-show","sync_unique":"","__v":0,"body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"ID of PageNode\",\n    \"1-0\": \"node_type\",\n    \"1-1\": \"String\",\n    \"2-0\": \"data\",\n    \"2-1\": \"Object\",\n    \"3-0\": \"children\",\n    \"3-1\": \"Array\",\n    \"1-2\": \"Type of PageNode\",\n    \"2-2\": \"Data for object related to PageNode\",\n    \"3-2\": \"Children PageNodes of this PageNode\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","version":"56cca51eca43550b002813fa","childrenPages":[]}

getLeague Instance Tree Show

The Show method returns the page node structure beneath the [League Instance](https://sportnginv2.readme.io/docs/league-instances-index). ###Parameters

Path Params

id:

required

integer

Id of LeagueInstance

Attributes

Name

Type

Description

Integer

ID of PageNode

node_type

String

Type of PageNode

data

Object

Data for object related to PageNode

children

Array

Children PageNodes of this PageNode

Definition

Examples

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/league_instance_tree/41683"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/league_instance_tree/41683")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/league_instance_tree/41683")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "node": {
        "id": 2458062,
        "node_type": "LeagueInstance",
        "data": {
            "created_at": "2016-03-22T12:46:58-07:00",
            "id": 41683,
            "league_id": 27737,
            "season_id": 267440,
            "updated_at": "2016-03-22T12:46:58-07:00"
        },
        "children": [
            {
                "node": {
                    "id": 2458064,
                    "node_type": "Subseason",
                    "data": {
                        "created_at": "2016-03-22T12:46:58-07:00",
                        "id": 291621,
                        "name": "Regular Season",
                        "position": 1,
                        "season_id": 267440,
                        "snl_scoring_enabled": true,
                        "statistic_grouping_id": 417884,
                        "updated_at": "2016-04-11T09:02:40-07:00",
                        "workers_completed": null,
                        "live_scoring_stat_configuration": {
                            "show_plus_minus": null,
                            "fair_play_points": false
                        }
                    },
                    "children": [
                        {
                            "node": {
                                "id": 2458074,
                                "node_type": "DivisionInstance",
                                "data": {
                                    "created_at": "2016-03-22T12:52:51-07:00",
                                    "division_id": 66180,
                                    "id": 181552,
                                    "max_standings_points": null,
                                    "non_standing": false,
                                    "updated_at": "2016-03-22T12:52:51-07:00",
                                    "division": {
                                        "abbrev": "Ocn",
                                        "button_title": "Oceanic",
                                        "created_at": "2016-03-22T12:52:51-07:00",
                                        "id": 66180,
                                        "image_id": null,
                                        "league_id": 27737,
                                        "name": "Oceanic Division",
                                        "primary_color": "00AEEF",
                                        "secondary_color": "666666",
                                        "updated_at": "2016-03-22T14:25:05-07:00"
                                    }
                                },
                                "children": [
                                    {
                                        "node": {
                                            "id": 2458139,
                                            "node_type": "TeamInstance",
                                            "data": {
                                                "abbrev": "Bos",
                                                "affects_standings": true,
                                                "button_title": "Boston",
                                                "created_at": "2016-03-22T13:19:12-07:00",
                                                "gender": "male",
                                                "id": 1876243,
                                                "image_id": null,
                                                "management_team_id": null,
                                                "name": "Boston Bears",
                                                "opponent": null,
                                                "parent_team_instance_id": null,
                                                "primary_color": "000000",
                                                "roster_id": 1837158,
                                                "secondary_color": "000000",
                                                "team_id": 1373611,
                                                "updated_at": "2016-03-23T09:34:28-07:00",
                                                "team": {
                                                    "abbrev": "Bos",
                                                    "android_whitelabel_url": null,
                                                    "button_title": "Boston",
                                                    "created_at": "2016-03-22T13:06:41-07:00",
                                                    "gender": "male",
                                                    "id": 1373611,
                                                    "image_id": null,
                                                    "ios_whitelabel_url": null,
                                                    "name": "Boston Bears",
                                                    "opponent": null,
                                                    "parent_team_id": null,
                                                    "primary_color": "000000",
                                                    "secondary_color": "000000",
                                                    "sport_id": 1,
                                                    "updated_at": "2016-03-23T09:34:28-07:00"
                                                }
                                            },
                                            "children": []
                                        }
                                    },
                                  ...

{"_id":"57052d36ecfca80e009992a8","slug":"divisions","title":"Divisions","__v":22,"api":{"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"category":"56e03709f97d422900d63922","isReference":true,"type":"basic","hidden":false,"link_url":"","order":5,"parentDoc":null,"excerpt":"While _not accessible directly through the API_, it is useful to understand the relationship between a Division and a [Division Instance](https://sportnginv2.readme.io/docs/division-instances-create).  A Division is a logical grouping of [Teams](https://sportnginv2.readme.io/docs/teams-show) in the [League](https://sportnginv2.readme.io/docs/leagues), and a [Division Instance](https://sportnginv2.readme.io/docs/division-instances-create) is the instance of that Division for the current [Season](https://sportnginv2.readme.io/docs/seasons-show).","githubsync":"","link_external":false,"user":"56e71f9edee212320019e731","sync_unique":"","updates":[],"version":"56cca51eca43550b002813fa","body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Unique id assigned by NGIN\",\n    \"1-0\": \"name\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Division name\",\n    \"2-0\": \"button_title\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Button title for the division\",\n    \"3-0\": \"abbrev\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Division abbreviation\",\n    \"4-0\": \"image_id\",\n    \"4-1\": \"Integer\",\n    \"4-2\": \"Image id for the division\",\n    \"5-0\": \"primary_color\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Primary color for the division\",\n    \"6-0\": \"secondary_color\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Secondary color for the division\",\n    \"7-0\": \"created_at\",\n    \"7-1\": \"Datetime\",\n    \"7-2\": \"Timestamp of creation\",\n    \"8-0\": \"updated_at\",\n    \"8-1\": \"Datetime\",\n    \"8-2\": \"Timestamp of last update\",\n    \"9-0\": \"league_id\",\n    \"9-1\": \"Integer\",\n    \"9-2\": \"League id the division belongs to\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]","createdAt":"2016-04-06T15:37:26.012Z","project":"5641217e0ee5370d00da636d","childrenPages":[]}

Divisions

While _not accessible directly through the API_, it is useful to understand the relationship between a Division and a [Division Instance](https://sportnginv2.readme.io/docs/division-instances-create). A Division is a logical grouping of [Teams](https://sportnginv2.readme.io/docs/teams-show) in the [League](https://sportnginv2.readme.io/docs/leagues), and a [Division Instance](https://sportnginv2.readme.io/docs/division-instances-create) is the instance of that Division for the current [Season](https://sportnginv2.readme.io/docs/seasons-show).

Attributes

Attribute

Type

Notes

Integer

Unique id assigned by NGIN

name

String

Division name

button_title

String

Button title for the division

abbrev

String

Division abbreviation

image_id

Integer

Image id for the division

primary_color

String

Primary color for the division

secondary_color

String

Secondary color for the division

created_at

Datetime

Timestamp of creation

updated_at

Datetime

Timestamp of last update

league_id

Integer

League id the division belongs to

{"_id":"57052e5e849f721900f279b4","__v":3,"hidden":false,"isReference":true,"order":6,"version":"56cca51eca43550b002813fa","sync_unique":"","user":"56e71f9edee212320019e731","editedParams":true,"editedParams2":true,"githubsync":"","link_url":"","parentDoc":null,"title":"Division Instances Index","updates":[],"api":{"params":[{"ref":"","required":true,"desc":"Id of subseason the divisions belong to","default":"","type":"int","name":"subseason_id","in":"query","_id":"57166fe3b5af590e00a0ffda"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"[\n    {\n        \"id\": 181552,\n        \"created_at\": \"2016-03-22T12:52:51-07:00\",\n        \"updated_at\": \"2016-03-22T12:52:51-07:00\",\n        \"division_id\": 66180,\n        \"non_standing\": false,\n        \"max_standings_points\": null\n    },\n    {\n        \"id\": 181553,\n        \"created_at\": \"2016-03-22T12:54:23-07:00\",\n        \"updated_at\": \"2016-03-22T12:54:23-07:00\",\n        \"division_id\": 66181,\n        \"non_standing\": false,\n        \"max_standings_points\": null\n    }\n]"}]},"settings":"","url":"/division_instances","auth":"required","examples":{"codes":[{"code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/division_instances?subseason_id=291621\"","language":"curl"},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/division_instances?subseason_id=291621\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/division_instances?subseason_id=291621\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get"},"category":"56e03709f97d422900d63922","createdAt":"2016-04-06T15:42:22.928Z","excerpt":"The Index method returns an array of Division Instances for the given `subseason_id`.  A Division Instance is an instance of a specific [Divisions](https://sportnginv2.readme.io/docs/divisions), and effectively represents a single [Season](https://sportnginv2.readme.io/docs/seasons-show) within the [League](https://sportnginv2.readme.io/docs/leagues).\n\n###Parameters","body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"1-0\": \"division_id\",\n    \"1-1\": \"Integer\",\n    \"2-0\": \"non_standing\",\n    \"2-1\": \"Boolean\",\n    \"2-2\": \"whether the division instance affects standings\",\n    \"3-0\": \"created_at\",\n    \"3-1\": \"Datetime\",\n    \"3-2\": \"Timestamp of creation\",\n    \"4-0\": \"updated_at\",\n    \"4-1\": \"Datetime\",\n    \"4-2\": \"Timestamp of last update\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","link_external":false,"project":"5641217e0ee5370d00da636d","slug":"division-instances-index","type":"get","childrenPages":[]}

getDivision Instances Index

The Index method returns an array of Division Instances for the given `subseason_id`. A Division Instance is an instance of a specific [Divisions](https://sportnginv2.readme.io/docs/divisions), and effectively represents a single [Season](https://sportnginv2.readme.io/docs/seasons-show) within the [League](https://sportnginv2.readme.io/docs/leagues). ###Parameters

Query Params

subseason_id:

required

integer

Id of subseason the divisions belong to

Attributes

Attribute

Type

Notes

Integer

division_id

Integer

non_standing

Boolean

whether the division instance affects standings

created_at

Datetime

Timestamp of creation

updated_at

Datetime

Timestamp of last update

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/division_instances?subseason_id=291621"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/division_instances?subseason_id=291621")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/division_instances?subseason_id=291621")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

[
    {
        "id": 181552,
        "created_at": "2016-03-22T12:52:51-07:00",
        "updated_at": "2016-03-22T12:52:51-07:00",
        "division_id": 66180,
        "non_standing": false,
        "max_standings_points": null
    },
    {
        "id": 181553,
        "created_at": "2016-03-22T12:54:23-07:00",
        "updated_at": "2016-03-22T12:54:23-07:00",
        "division_id": 66181,
        "non_standing": false,
        "max_standings_points": null
    }
]

{"_id":"57eeb35fcc36920e00bff4c0","isReference":true,"updates":[],"githubsync":"","hidden":false,"api":{"auth":"required","examples":{"codes":[{"name":"cURL - New Division","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN  \" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n  \"parent_node_id\": 2458064,\n  \"existing_or_new\": \"new\",\n  \"top_template_id\": 23221,\n  \"bottom_template_id\": 23221,\n  \"division\": {\n    \"name\": \"Test division\",\n    \"button_title\": \"Test\",\n    \"abbrev\": \"TD\",\n    \"primary_color\": \"FFFFFF\",\n    \"secondary_color\": \"000000\"\n  }\n}' \"https://api.sportngin.com/division_instances\"","language":"curl"},{"name":"Ruby - New Division","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/division_instances\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n  \\\"parent_node_id\\\": 2458064,\\n  \\\"existing_or_new\\\": \\\"new\\\",\\n  \\\"top_template_id\\\": 23221,\\n  \\\"bottom_template_id\\\": 23221,\\n  \\\"division\\\": {\\n    \\\"name\\\": \\\"Test division\\\",\\n    \\\"button_title\\\": \\\"Test\\\",\\n    \\\"abbrev\\\": \\\"TD\\\",\\n    \\\"primary_color\\\": \\\"FFFFFF\\\",\\n    \\\"secondary_color\\\": \\\"000000\\\"\\n  }\\n}\"\n\nresponse = http.request(request)\nputs response.read_body","language":"ruby"},{"name":"Java - New Division","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n  \\\"parent_node_id\\\": 2458064,\\n  \\\"existing_or_new\\\": \\\"new\\\",\\n  \\\"top_template_id\\\": 23221,\\n  \\\"bottom_template_id\\\": 23221,\\n  \\\"division\\\": {\\n    \\\"name\\\": \\\"Test division\\\",\\n    \\\"button_title\\\": \\\"Test\\\",\\n    \\\"abbrev\\\": \\\"TD\\\",\\n    \\\"primary_color\\\": \\\"FFFFFF\\\",\\n    \\\"secondary_color\\\": \\\"000000\\\"\\n  }\\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/division_instances\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"},{"name":"cURL - Existing Division","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN  \" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n  \"parent_node_id\": 2458062,\n  \"division_id\":  66180\n}' \"https://api.sportngin.com/division_instances\"","language":"curl"},{"name":"Ruby - Existing Division","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/division_instances\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n  \\\"parent_node_id\\\": 2458062,\\n  \\\"division_id\\\":  66180\\n}\"\n\nresponse = http.request(request)\nputs response.read_body","language":"ruby"},{"name":"Java - Existing Division","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n  \\\"parent_node_id\\\": 2458062,\\n  \\\"division_id\\\":  66180\\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/division_instances\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"}]},"method":"post","params":[{"_id":"57eeb756cc36920e00bff4c5","ref":"","in":"body","required":true,"desc":"","default":"","type":"int","name":"parent_node_id"},{"_id":"57eeb756cc36920e00bff4c4","default":"","desc":"Needed if the division instance is not being created as part of an existing division","in":"body","name":"new","ref":"","required":false,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 209310,\n    \"created_at\": \"2016-09-30T12:00:52-07:00\",\n    \"updated_at\": \"2016-09-30T12:00:52-07:00\",\n    \"division_id\": 66180,\n    \"non_standing\": false,\n    \"max_standings_points\": null\n}","name":""}]},"settings":"","url":"/division_instances"},"createdAt":"2016-09-30T18:47:59.386Z","excerpt":"The Create method accepts a single Division Instance (see attributes above) and creates a new record in SportsEngine.\n\n###Parameters","link_external":false,"project":"5641217e0ee5370d00da636d","slug":"division-instances-create","title":"Division Instances Create","__v":2,"body":"","user":"56548c568975c70d002ea4b4","version":"56cca51eca43550b002813fa","order":7,"parentDoc":null,"sync_unique":"","type":"post","category":"56e03709f97d422900d63922","link_url":"","childrenPages":[]}

postDivision Instances Create

The Create method accepts a single Division Instance (see attributes above) and creates a new record in SportsEngine. ###Parameters

Body Params

parent_node_id:

required

integer

new:

string

Needed if the division instance is not being created as part of an existing division

Definition

Examples

cURL - New Division

Ruby - New Division

Java - New Division

cURL - Existing Division

Ruby - Existing Division

Java - Existing Division

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN  " -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
  "parent_node_id": 2458064,
  "existing_or_new": "new",
  "top_template_id": 23221,
  "bottom_template_id": 23221,
  "division": {
    "name": "Test division",
    "button_title": "Test",
    "abbrev": "TD",
    "primary_color": "FFFFFF",
    "secondary_color": "000000"
  }
}' "https://api.sportngin.com/division_instances"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/division_instances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n  \"parent_node_id\": 2458064,\n  \"existing_or_new\": \"new\",\n  \"top_template_id\": 23221,\n  \"bottom_template_id\": 23221,\n  \"division\": {\n    \"name\": \"Test division\",\n    \"button_title\": \"Test\",\n    \"abbrev\": \"TD\",\n    \"primary_color\": \"FFFFFF\",\n    \"secondary_color\": \"000000\"\n  }\n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"parent_node_id\": 2458064,\n  \"existing_or_new\": \"new\",\n  \"top_template_id\": 23221,\n  \"bottom_template_id\": 23221,\n  \"division\": {\n    \"name\": \"Test division\",\n    \"button_title\": \"Test\",\n    \"abbrev\": \"TD\",\n    \"primary_color\": \"FFFFFF\",\n    \"secondary_color\": \"000000\"\n  }\n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/division_instances")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN  " -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
  "parent_node_id": 2458062,
  "division_id":  66180
}' "https://api.sportngin.com/division_instances"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/division_instances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n  \"parent_node_id\": 2458062,\n  \"division_id\":  66180\n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"parent_node_id\": 2458062,\n  \"division_id\":  66180\n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/division_instances")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 209310,
    "created_at": "2016-09-30T12:00:52-07:00",
    "updated_at": "2016-09-30T12:00:52-07:00",
    "division_id": 66180,
    "non_standing": false,
    "max_standings_points": null
}

{"_id":"57eeb2dd5347840e0053f1a8","order":8,"hidden":false,"link_external":false,"link_url":"","project":"5641217e0ee5370d00da636d","title":"Division Instances Update","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X PUT -H \"Authorization: Bearer ACCESS_TOKEN  \" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n\t\"max_standings_points\": 44.00\n}\n}' \"https://api.sportngin.com/division_instances/181552\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/division_instances/181552\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"max_standings_points\\\": 44.00 \\n}\"\n\nresponse = http.request(request)\nputs response.read_body"},{"code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"max_standings_points\\\": 44.00 \\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/division_instances/181552\")\n  .put(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"}]},"method":"put","params":[{"default":"","type":"int","name":"id","_id":"577e8f45a74eb40e00d97b62","ref":"","in":"path","required":true,"desc":"Id of DivisionInstance to update"}],"results":{"codes":[{"status":200,"name":"","code":"{\n    \"id\": 181552,\n    \"created_at\": \"2016-03-22T12:52:51-07:00\",\n    \"updated_at\": \"2016-09-30T11:40:25-07:00\",\n    \"division_id\": 66180,\n    \"non_standing\": false,\n    \"max_standings_points\": \"44.0\"\n}","language":"json"}]},"settings":"","url":"/division_instances/:id"},"createdAt":"2016-09-30T18:45:49.661Z","excerpt":"The Update method updates the provided fields for a given `id`.\n\n###Parameters","type":"put","updates":[],"version":"56cca51eca43550b002813fa","isReference":true,"parentDoc":null,"slug":"division-instances-update","githubsync":"","sync_unique":"","user":"56548c568975c70d002ea4b4","__v":0,"body":"","category":"56e03709f97d422900d63922","childrenPages":[]}

putDivision Instances Update

The Update method updates the provided fields for a given `id`. ###Parameters

Path Params

id:

required

integer

Id of DivisionInstance to update

Definition

Examples

curl -X PUT -H "Authorization: Bearer ACCESS_TOKEN  " -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
	"max_standings_points": 44.00
}
}' "https://api.sportngin.com/division_instances/181552"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/division_instances/181552")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"max_standings_points\": 44.00 \n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"max_standings_points\": 44.00 \n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/division_instances/181552")
  .put(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 181552,
    "created_at": "2016-03-22T12:52:51-07:00",
    "updated_at": "2016-09-30T11:40:25-07:00",
    "division_id": 66180,
    "non_standing": false,
    "max_standings_points": "44.0"
}

{"_id":"57eeaabb7a53690e000abc13","excerpt":"The Delete method permanently deletes the associated DivisionInstance record in SportsEngine.  *This method takes action upon initial invocation and cannot be reversed.*\n\n###Parameters","githubsync":"","isReference":true,"link_external":false,"link_url":"","title":"Division Instances Delete","updates":[],"category":"56e03709f97d422900d63922","createdAt":"2016-09-30T18:11:07.379Z","order":9,"parentDoc":null,"type":"delete","body":"","project":"5641217e0ee5370d00da636d","sync_unique":"","user":"56548c568975c70d002ea4b4","version":"56cca51eca43550b002813fa","api":{"examples":{"codes":[{"language":"curl","code":"curl -X DELETE -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/division_instances/209258\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/division_instances/209258\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/division_instances/209258\")\n  .delete(null)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"delete","params":[{"name":"id","_id":"57114eae5ba0d80e00f51614","ref":"","in":"path","required":true,"desc":"Id belonging to the division_instance of interest","default":"","type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 209258,\n  \"created_at\": \"2016-09-28T14:38:04-07:00\",\n  \"updated_at\": \"2016-09-28T14:38:04-07:00\",\n  \"division_id\": 77569,\n  \"non_standing\": false,\n  \"max_standings_points\": null\n}","name":""}]},"settings":"","url":"/division_instances/:id","auth":"required"},"hidden":false,"slug":"division-instances-delete","__v":0,"childrenPages":[]}

deleteDivision Instances Delete

The Delete method permanently deletes the associated DivisionInstance record in SportsEngine. *This method takes action upon initial invocation and cannot be reversed.* ###Parameters

Path Params

id:

required

integer

Id belonging to the division_instance of interest

Definition

Examples

curl -X DELETE -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/division_instances/209258"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/division_instances/209258")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/division_instances/209258")
  .delete(null)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
  "id": 209258,
  "created_at": "2016-09-28T14:38:04-07:00",
  "updated_at": "2016-09-28T14:38:04-07:00",
  "division_id": 77569,
  "non_standing": false,
  "max_standings_points": null
}

{"_id":"57f26f94130b941700a4bc47","slug":"teams","sync_unique":"","type":"basic","updates":[],"api":{"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"githubsync":"","link_external":false,"parentDoc":null,"title":"Teams","category":"56e03709f97d422900d63922","link_url":"","order":10,"project":"5641217e0ee5370d00da636d","excerpt":"A Team can belong to a Division in a [League](https://sportnginv2.readme.io/docs/leagues), a league with no divisions, or exist as solo team league. A [Team Instance](https://sportnginv2.readme.io/docs/team-instances-create) is the instance of that Team for the current [Season](https://sportnginv2.readme.io/docs/seasons-show).","hidden":false,"isReference":true,"user":"56548c568975c70d002ea4b4","__v":0,"body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"1-0\": \"name\",\n    \"1-1\": \"String\",\n    \"2-0\": \"button_title\",\n    \"2-1\": \"String\",\n    \"3-0\": \"abbrev\",\n    \"3-1\": \"String\",\n    \"4-0\": \"image_id\",\n    \"4-1\": \"Integer\",\n    \"5-0\": \"primary_color\",\n    \"5-1\": \"String\",\n    \"6-0\": \"secondary_color\",\n    \"6-1\": \"String\",\n    \"7-0\": \"gender\",\n    \"7-1\": \"Enum\",\n    \"8-0\": \"created_at\",\n    \"8-1\": \"DateTime\",\n    \"9-0\": \"updated_at\",\n    \"9-1\": \"DateTime\",\n    \"10-0\": \"sport_id\",\n    \"10-1\": \"Integer\",\n    \"11-0\": \"opponent\",\n    \"11-1\": \"Integer\",\n    \"12-0\": \"parent_team_id\",\n    \"12-1\": \"Integer\",\n    \"13-0\": \"ios_whitelabel_url\",\n    \"13-1\": \"String\",\n    \"14-0\": \"android_whitelabel_url\",\n    \"14-1\": \"String\",\n    \"0-2\": \"Unique id assigned by NGIN\",\n    \"1-2\": \"Team name\",\n    \"2-2\": \"Button title for the team\",\n    \"3-2\": \"Team abbreviation\",\n    \"4-2\": \"Image id for the team\",\n    \"5-2\": \"Primary color for the team\",\n    \"6-2\": \"Primary color for the team\",\n    \"8-2\": \"Timestamp of creation\",\n    \"9-2\": \"Timestamp of last update\",\n    \"12-2\": \"Id of team that is above this team\",\n    \"7-2\": \"Gender for the team\",\n    \"10-2\": \"Id of the sport which the team belongs to\",\n    \"11-2\": \"Set to `1` if the team is in the system as an opponent in a solo team league. Default value = `null`\",\n    \"13-2\": \"URL of the iTunes store item for the team's app, if applicable\",\n    \"14-2\": \"URL of the Google Play store item for the team's app, if applicable\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]","createdAt":"2016-10-03T14:47:48.783Z","version":"56cca51eca43550b002813fa","childrenPages":[]}

Teams

A Team can belong to a Division in a [League](https://sportnginv2.readme.io/docs/leagues), a league with no divisions, or exist as solo team league. A [Team Instance](https://sportnginv2.readme.io/docs/team-instances-create) is the instance of that Team for the current [Season](https://sportnginv2.readme.io/docs/seasons-show).

Attributes

Integer

Unique id assigned by NGIN

name

String

Team name

button_title

String

Button title for the team

abbrev

String

Team abbreviation

image_id

Integer

Image id for the team

primary_color

String

Primary color for the team

secondary_color

String

Primary color for the team

gender

Enum

Gender for the team

created_at

DateTime

Timestamp of creation

updated_at

DateTime

Timestamp of last update

sport_id

Integer

Id of the sport which the team belongs to

opponent

Integer

Set to 1 if the team is in the system as an opponent in a solo team league. Default value = null

parent_team_id

Integer

Id of team that is above this team

ios_whitelabel_url

String

URL of the iTunes store item for the team's app, if applicable

android_whitelabel_url

String

URL of the Google Play store item for the team's app, if applicable

{"_id":"571941aaac1e2e0e00183463","category":"56e03709f97d422900d63922","githubsync":"","sync_unique":"","type":"get","user":"56548c568975c70d002ea4b4","version":"56cca51eca43550b002813fa","api":{"url":"/teams","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/teams?site_id=11953\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/teams?site_id=11953\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/teams?site_id=11953\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"},{"name":"cURL - with parameter","language":"curl","code":"curl -X GET -H \"Authorization: Bearer cb2e3bd276c7fdc8e0a9989c88c032b3\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Cache-Control: no-cache\" -H \"Postman-Token: 5021fb49-93c1-928f-6a63-f21dec82d677\" \"https://api.sportngin.com/teams?site_id=11953¤t_subseason_only=1\""},{"language":"ruby","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/teams?site_id=11953¤t_subseason_only=1\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer cb2e3bd276c7fdc8e0a9989c88c032b3\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"cache-control\", \"no-cache\")\n  .addHeader(\"postman-token\", \"cb5b6b64-402a-3de6-6eff-cbe641ac55b2\")\n  .build();\n\nResponse response = client.newCall(request).execute();","name":"Ruby - with parameter"},{"name":"Java - with parameter","language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/teams?site_id=11953¤t_subseason_only=1\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer cb2e3bd276c7fdc8e0a9989c88c032b3\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"cache-control\", \"no-cache\")\n  .addHeader(\"postman-token\", \"cb5b6b64-402a-3de6-6eff-cbe641ac55b2\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"type":"int","name":"site_id","in":"query","_id":"571941aaac1e2e0e00183469","ref":"","required":true,"desc":"Id of site the teams belong to","default":""},{"type":"int","name":"league_ids","in":"query","_id":"571941aaac1e2e0e00183468","ref":"","required":true,"desc":"Id of leagues the teams belong to","default":""},{"required":true,"desc":"Id of teams to be returned","default":"","type":"int","name":"team_ids","in":"query","_id":"571941aaac1e2e0e00183467","ref":""},{"desc":"Id of sport the teams belong to","default":"","type":"int","name":"sport_id","in":"query","_id":"571941aaac1e2e0e00183466","ref":"","required":false},{"name":"write_access","in":"query","_id":"571941aaac1e2e0e00183465","ref":"","required":false,"desc":"","default":"","type":"int"},{"desc":"","default":"","type":"int","name":"current_subseason_only","in":"query","_id":"571941aaac1e2e0e00183464","ref":"","required":false}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n    {\n        \"id\": 1373611,\n        \"name\": \"Boston Bears\",\n        \"button_title\": \"Boston\",\n        \"abbrev\": \"Bos\",\n        \"image_id\": null,\n        \"primary_color\": \"000000\",\n        \"secondary_color\": \"000000\",\n        \"gender\": \"male\",\n        \"created_at\": \"2016-03-22T13:06:41-07:00\",\n        \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n        \"sport_id\": 1,\n        \"opponent\": null,\n        \"parent_team_id\": null,\n        \"ios_whitelabel_url\": null,\n        \"android_whitelabel_url\": null,\n        \"sites\": [\n            {\n                \"id\": 11953,\n                \"domain_id\": 1149,\n                \"domain_name\": \"sportngin.com\",\n                \"subdomain\": \"apidemo\",\n                \"product_id\": 14,\n                \"name\": \"Sport Ngin API Demo Site\",\n                \"short_name\": \"Sport Ngin API Demo Site\",\n                \"created_on\": \"2016-02-24T06:32:26-08:00\",\n                \"updated_on\": \"2016-04-19T10:52:59-07:00\",\n                \"created_by_user_id\": 3156422,\n                \"updated_by_user_id\": null,\n                \"timezone\": \"US/Central\",\n                \"twitter_user_id\": null,\n                \"layout_theme_id\": 51,\n                \"secure_subdomain\": \"apidemo\",\n                \"address_id\": 4447713,\n                \"membership_privacy\": \"open\",\n                \"membership_grace_period\": 1,\n                \"boss_billing_account_id\": null,\n                \"boss_organization_id\": 27743\n            }\n        ],\n        \"leagues\": [\n            {\n                \"id\": 27737,\n                \"name\": \"Eastern League\",\n                \"current_subseason_id\": 291621,\n                \"site_id\": 11953,\n                \"sport_id\": 1,\n                \"image_id\": null,\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n                \"button_title\": \"Eastern\",\n                \"primary_color\": \"00AEEF\",\n                \"secondary_color\": \"666666\",\n                \"gender\": \"male\",\n                \"abbrev\": \"East\",\n                \"score_ribbon\": false,\n                \"tweet_games\": null,\n                \"game_sheet_label\": \"gamesheet\"\n            }\n        ],\n        \"thumbnails\": {},\n        \"thumbnails_ssl\": {},\n        \"current_subseason_ids\": [\n            291621\n        ],\n        \"seasons\": [\n            {\n                \"id\": 267440,\n                \"name\": \"2016\",\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                \"solo_team_league_id\": null,\n                \"has_metadata\": null,\n                \"show_shared_schedule\": false,\n                \"stat_preference\": {\n                    \"id\": 292407,\n                    \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"created_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"game_defaults\": {\n                        \"auto_navigate_to_play_details\": true,\n                        \"field_of_play_enabled\": false,\n                        \"game_misconduct_time\": 0,\n                        \"ice_hockey_goalie_order_by\": null,\n                        \"ice_hockey_goalie_order_by_secondary\": null,\n                        \"ice_hockey_goalie_order_dir\": null,\n                        \"ice_hockey_goalie_order_dir_secondary\": null,\n                        \"ice_hockey_goalie_stat_qualify_by\": null,\n                        \"ice_hockey_goalie_stat_qualify_val\": null,\n                        \"ice_hockey_skater_order_by\": null,\n                        \"ice_hockey_skater_order_by_secondary\": null,\n                        \"ice_hockey_skater_order_dir\": null,\n                        \"ice_hockey_skater_order_dir_secondary\": null,\n                        \"ice_hockey_skater_stat_qualify_by\": null,\n                        \"ice_hockey_skater_stat_qualify_val\": null,\n                        \"ice_hockey_team_scoring_order_by\": \"pts\",\n                        \"ice_hockey_team_scoring_order_by_secondary\": null,\n                        \"ice_hockey_team_scoring_order_dir\": \"desc\",\n                        \"ice_hockey_team_scoring_order_dir_secondary\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_by\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_val\": null,\n                        \"ice_hockey_team_stats_order_by\": null,\n                        \"ice_hockey_team_stats_order_by_secondary\": null,\n                        \"ice_hockey_team_stats_order_dir\": null,\n                        \"ice_hockey_team_stats_order_dir_secondary\": null,\n                        \"ice_hockey_team_stats_stat_qualify_by\": null,\n                        \"ice_hockey_team_stats_stat_qualify_val\": null,\n                        \"intermission_length\": 1,\n                        \"major_adjustment_time\": 0,\n                        \"major_penalty_time\": 5,\n                        \"match_penalty_time\": 5,\n                        \"max_goal_differential\": 0,\n                        \"max_player_major_penalties\": 2,\n                        \"max_player_penalties\": 5,\n                        \"max_team_penalties\": 15,\n                        \"minor_adjustment_time\": 0,\n                        \"minor_penalty_time\": 2,\n                        \"misconduct_time\": 10,\n                        \"overtime_intervals\": 2,\n                        \"overtime_length\": \"5\",\n                        \"post_live_updates\": true,\n                        \"regulation_time_intervals\": null,\n                        \"shootout_enabled\": false,\n                        \"stop_run_time\": true,\n                        \"time_interval_name\": \"period\",\n                        \"time_intervals\": [\n                            \"20\",\n                            \"20\",\n                            \"20\"\n                        ],\n                        \"timeout_time\": 1,\n                        \"timeouts\": 1,\n                        \"track_goal_types\": true,\n                        \"track_player_sog\": true,\n                        \"warmup_length\": 5\n                    },\n                    \"season_id\": 267440,\n                    \"original_scorer_can_edit\": null,\n                    \"force_real_time_scoring\": false,\n                    \"stat_tool_id\": 1848623,\n                    \"stats_can_be_unlinked\": null,\n                    \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n                    \"can_edit_final\": \"league_owner\",\n                    \"traded_player_stats\": null,\n                    \"game_sheet_auto_summary_enabled\": true,\n                    \"visible_stats\": \"league_xor_division\"\n                },\n                \"subseasons\": [\n                    {\n                        \"id\": 291621,\n                        \"name\": \"Regular Season\",\n                        \"season_id\": 267440,\n                        \"position\": 1,\n                        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"updated_at\": \"2016-04-20T09:47:22-07:00\",\n                        \"snl_scoring_enabled\": true,\n                        \"statistic_grouping_id\": 417884,\n                        \"workers_completed\": null,\n                        \"standing_preference\": {\n                            \"id\": 110425,\n                            \"standing_tool_id\": 1848627,\n                            \"standing_type_id\": 5,\n                            \"standings_aggregation_level\": \"league\",\n                            \"qualifiers\": null,\n                            \"qualifier_limit\": null,\n                            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"winning_team_custom_points\": null,\n                            \"losing_team_custom_points\": null,\n                            \"tied_team_custom_points\": null,\n                            \"label_mapping\": {},\n                            \"extended_fields\": [\n                                \"win_count\",\n                                \"loss_count\",\n                                \"tie_count\",\n                                \"points\"\n                            ],\n                            \"order_rule\": 1,\n                            \"overtime_win_custom_points\": null,\n                            \"overtime_loss_custom_points\": null,\n                            \"overtime_wins_include_in_wins\": true,\n                            \"overtime_losses_include_in_losses\": true,\n                            \"legacy_custom_points\": false\n                        },\n                        \"live_scoring_stat_configuration\": {\n                            \"show_plus_minus\": null,\n                            \"fair_play_points\": false\n                        }\n                    }\n                ]\n            }\n        ],\n        \"subseason_team_instance_mapping\": [\n            {\n                \"subseason_id\": 291621,\n                \"team_instance_id\": 1876243\n            }\n        ],\n        \"league_name\": \"Eastern League\",\n        \"site_name\": \"Sport Ngin API Demo Site\",\n        \"sport_name\": \"Ice Hockey\"\n    },\n    ...\n]"}]},"settings":""},"createdAt":"2016-04-21T21:10:02.860Z","editedParams2":true,"isReference":true,"link_url":"","order":11,"parentDoc":null,"project":"5641217e0ee5370d00da636d","title":"Teams Index","body":"","editedParams":true,"excerpt":"The Index method returns an array of Teams matching the given parameters.\n\n###Parameters","__v":0,"hidden":false,"link_external":false,"slug":"teams-index","updates":[],"childrenPages":[]}

getTeams Index

The Index method returns an array of Teams matching the given parameters. ###Parameters

Query Params

site_id:

required

integer

Id of site the teams belong to

league_ids:

required

integer

Id of leagues the teams belong to

team_ids:

required

integer

Id of teams to be returned

sport_id:

integer

Id of sport the teams belong to

write_access:

integer

current_subseason_only:

integer

Definition

Examples

cURL - with parameter

Ruby - with parameter

Java - with parameter

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/teams?site_id=11953"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/teams?site_id=11953")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/teams?site_id=11953")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

curl -X GET -H "Authorization: Bearer cb2e3bd276c7fdc8e0a9989c88c032b3" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Cache-Control: no-cache" -H "Postman-Token: 5021fb49-93c1-928f-6a63-f21dec82d677" "https://api.sportngin.com/teams?site_id=11953¤t_subseason_only=1"

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/teams?site_id=11953¤t_subseason_only=1")
  .get()
  .addHeader("authorization", "Bearer cb2e3bd276c7fdc8e0a9989c88c032b3")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("cache-control", "no-cache")
  .addHeader("postman-token", "cb5b6b64-402a-3de6-6eff-cbe641ac55b2")
  .build();

Response response = client.newCall(request).execute();

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/teams?site_id=11953¤t_subseason_only=1")
  .get()
  .addHeader("authorization", "Bearer cb2e3bd276c7fdc8e0a9989c88c032b3")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("cache-control", "no-cache")
  .addHeader("postman-token", "cb5b6b64-402a-3de6-6eff-cbe641ac55b2")
  .build();

Response response = client.newCall(request).execute();

Result Format

[
    {
        "id": 1373611,
        "name": "Boston Bears",
        "button_title": "Boston",
        "abbrev": "Bos",
        "image_id": null,
        "primary_color": "000000",
        "secondary_color": "000000",
        "gender": "male",
        "created_at": "2016-03-22T13:06:41-07:00",
        "updated_at": "2016-03-23T09:34:28-07:00",
        "sport_id": 1,
        "opponent": null,
        "parent_team_id": null,
        "ios_whitelabel_url": null,
        "android_whitelabel_url": null,
        "sites": [
            {
                "id": 11953,
                "domain_id": 1149,
                "domain_name": "sportngin.com",
                "subdomain": "apidemo",
                "product_id": 14,
                "name": "Sport Ngin API Demo Site",
                "short_name": "Sport Ngin API Demo Site",
                "created_on": "2016-02-24T06:32:26-08:00",
                "updated_on": "2016-04-19T10:52:59-07:00",
                "created_by_user_id": 3156422,
                "updated_by_user_id": null,
                "timezone": "US/Central",
                "twitter_user_id": null,
                "layout_theme_id": 51,
                "secure_subdomain": "apidemo",
                "address_id": 4447713,
                "membership_privacy": "open",
                "membership_grace_period": 1,
                "boss_billing_account_id": null,
                "boss_organization_id": 27743
            }
        ],
        "leagues": [
            {
                "id": 27737,
                "name": "Eastern League",
                "current_subseason_id": 291621,
                "site_id": 11953,
                "sport_id": 1,
                "image_id": null,
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-24T07:20:49-07:00",
                "button_title": "Eastern",
                "primary_color": "00AEEF",
                "secondary_color": "666666",
                "gender": "male",
                "abbrev": "East",
                "score_ribbon": false,
                "tweet_games": null,
                "game_sheet_label": "gamesheet"
            }
        ],
        "thumbnails": {},
        "thumbnails_ssl": {},
        "current_subseason_ids": [
            291621
        ],
        "seasons": [
            {
                "id": 267440,
                "name": "2016",
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-22T12:46:58-07:00",
                "solo_team_league_id": null,
                "has_metadata": null,
                "show_shared_schedule": false,
                "stat_preference": {
                    "id": 292407,
                    "updated_on": "2016-03-22T12:46:58-07:00",
                    "created_on": "2016-03-22T12:46:58-07:00",
                    "game_defaults": {
                        "auto_navigate_to_play_details": true,
                        "field_of_play_enabled": false,
                        "game_misconduct_time": 0,
                        "ice_hockey_goalie_order_by": null,
                        "ice_hockey_goalie_order_by_secondary": null,
                        "ice_hockey_goalie_order_dir": null,
                        "ice_hockey_goalie_order_dir_secondary": null,
                        "ice_hockey_goalie_stat_qualify_by": null,
                        "ice_hockey_goalie_stat_qualify_val": null,
                        "ice_hockey_skater_order_by": null,
                        "ice_hockey_skater_order_by_secondary": null,
                        "ice_hockey_skater_order_dir": null,
                        "ice_hockey_skater_order_dir_secondary": null,
                        "ice_hockey_skater_stat_qualify_by": null,
                        "ice_hockey_skater_stat_qualify_val": null,
                        "ice_hockey_team_scoring_order_by": "pts",
                        "ice_hockey_team_scoring_order_by_secondary": null,
                        "ice_hockey_team_scoring_order_dir": "desc",
                        "ice_hockey_team_scoring_order_dir_secondary": null,
                        "ice_hockey_team_scoring_stat_qualify_by": null,
                        "ice_hockey_team_scoring_stat_qualify_val": null,
                        "ice_hockey_team_stats_order_by": null,
                        "ice_hockey_team_stats_order_by_secondary": null,
                        "ice_hockey_team_stats_order_dir": null,
                        "ice_hockey_team_stats_order_dir_secondary": null,
                        "ice_hockey_team_stats_stat_qualify_by": null,
                        "ice_hockey_team_stats_stat_qualify_val": null,
                        "intermission_length": 1,
                        "major_adjustment_time": 0,
                        "major_penalty_time": 5,
                        "match_penalty_time": 5,
                        "max_goal_differential": 0,
                        "max_player_major_penalties": 2,
                        "max_player_penalties": 5,
                        "max_team_penalties": 15,
                        "minor_adjustment_time": 0,
                        "minor_penalty_time": 2,
                        "misconduct_time": 10,
                        "overtime_intervals": 2,
                        "overtime_length": "5",
                        "post_live_updates": true,
                        "regulation_time_intervals": null,
                        "shootout_enabled": false,
                        "stop_run_time": true,
                        "time_interval_name": "period",
                        "time_intervals": [
                            "20",
                            "20",
                            "20"
                        ],
                        "timeout_time": 1,
                        "timeouts": 1,
                        "track_goal_types": true,
                        "track_player_sog": true,
                        "warmup_length": 5
                    },
                    "season_id": 267440,
                    "original_scorer_can_edit": null,
                    "force_real_time_scoring": false,
                    "stat_tool_id": 1848623,
                    "stats_can_be_unlinked": null,
                    "scoring_methods": "--- \n- live\n- mass\n- tabular\n- quick\n",
                    "can_edit_final": "league_owner",
                    "traded_player_stats": null,
                    "game_sheet_auto_summary_enabled": true,
                    "visible_stats": "league_xor_division"
                },
                "subseasons": [
                    {
                        "id": 291621,
                        "name": "Regular Season",
                        "season_id": 267440,
                        "position": 1,
                        "created_at": "2016-03-22T12:46:58-07:00",
                        "updated_at": "2016-04-20T09:47:22-07:00",
                        "snl_scoring_enabled": true,
                        "statistic_grouping_id": 417884,
                        "workers_completed": null,
                        "standing_preference": {
                            "id": 110425,
                            "standing_tool_id": 1848627,
                            "standing_type_id": 5,
                            "standings_aggregation_level": "league",
                            "qualifiers": null,
                            "qualifier_limit": null,
                            "created_at": "2016-03-22T12:46:58-07:00",
                            "updated_at": "2016-03-22T12:46:58-07:00",
                            "winning_team_custom_points": null,
                            "losing_team_custom_points": null,
                            "tied_team_custom_points": null,
                            "label_mapping": {},
                            "extended_fields": [
                                "win_count",
                                "loss_count",
                                "tie_count",
                                "points"
                            ],
                            "order_rule": 1,
                            "overtime_win_custom_points": null,
                            "overtime_loss_custom_points": null,
                            "overtime_wins_include_in_wins": true,
                            "overtime_losses_include_in_losses": true,
                            "legacy_custom_points": false
                        },
                        "live_scoring_stat_configuration": {
                            "show_plus_minus": null,
                            "fair_play_points": false
                        }
                    }
                ]
            }
        ],
        "subseason_team_instance_mapping": [
            {
                "subseason_id": 291621,
                "team_instance_id": 1876243
            }
        ],
        "league_name": "Eastern League",
        "site_name": "Sport Ngin API Demo Site",
        "sport_name": "Ice Hockey"
    },
    ...
]

{"_id":"571942ddac1e2e0e00183470","category":"56e03709f97d422900d63922","slug":"teams-show","type":"get","updates":[],"version":"56cca51eca43550b002813fa","order":12,"title":"Teams Show","body":"","editedParams2":true,"excerpt":"The Show method returns a single Team for a given `id`.\n\n###Parameters","githubsync":"","isReference":true,"project":"5641217e0ee5370d00da636d","sync_unique":"","createdAt":"2016-04-21T21:15:09.174Z","editedParams":true,"hidden":false,"parentDoc":null,"__v":0,"api":{"params":[{"ref":"","required":true,"desc":"Id of the team","default":"","type":"int","name":"id","in":"path","_id":"571941aaac1e2e0e00183469"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"id\": 1373611,\n    \"name\": \"Boston Bears\",\n    \"button_title\": \"Boston\",\n    \"abbrev\": \"Bos\",\n    \"image_id\": null,\n    \"primary_color\": \"000000\",\n    \"secondary_color\": \"000000\",\n    \"gender\": \"male\",\n    \"created_at\": \"2016-03-22T13:06:41-07:00\",\n    \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n    \"sport_id\": 1,\n    \"opponent\": null,\n    \"parent_team_id\": null,\n    \"ios_whitelabel_url\": null,\n    \"android_whitelabel_url\": null,\n    \"sites\": [\n        {\n            \"id\": 11953,\n            \"domain_id\": 1149,\n            \"domain_name\": \"sportngin.com\",\n            \"subdomain\": \"apidemo\",\n            \"product_id\": 14,\n            \"name\": \"Sport Ngin API Demo Site\",\n            \"short_name\": \"Sport Ngin API Demo Site\",\n            \"created_on\": \"2016-02-24T06:32:26-08:00\",\n            \"updated_on\": \"2016-04-19T10:52:59-07:00\",\n            \"created_by_user_id\": 3156422,\n            \"updated_by_user_id\": null,\n            \"timezone\": \"US/Central\",\n            \"twitter_user_id\": null,\n            \"layout_theme_id\": 51,\n            \"secure_subdomain\": \"apidemo\",\n            \"address_id\": 4447713,\n            \"membership_privacy\": \"open\",\n            \"membership_grace_period\": 1,\n            \"boss_billing_account_id\": null,\n            \"boss_organization_id\": 27743\n        }\n    ],\n    \"leagues\": [\n        {\n            \"id\": 27737,\n            \"name\": \"Eastern League\",\n            \"current_subseason_id\": 291621,\n            \"site_id\": 11953,\n            \"sport_id\": 1,\n            \"image_id\": null,\n            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n            \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n            \"button_title\": \"Eastern\",\n            \"primary_color\": \"00AEEF\",\n            \"secondary_color\": \"666666\",\n            \"gender\": \"male\",\n            \"abbrev\": \"East\",\n            \"score_ribbon\": false,\n            \"tweet_games\": null,\n            \"game_sheet_label\": \"gamesheet\"\n        }\n    ],\n    \"thumbnails\": {},\n    \"thumbnails_ssl\": {},\n    \"current_subseason_ids\": [\n        291621\n    ],\n    \"seasons\": [\n        {\n            \"id\": 267440,\n            \"name\": \"2016\",\n            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n            \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n            \"solo_team_league_id\": null,\n            \"has_metadata\": null,\n            \"show_shared_schedule\": false,\n            \"stat_preference\": {\n                \"id\": 292407,\n                \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n                \"created_on\": \"2016-03-22T12:46:58-07:00\",\n                \"game_defaults\": {\n                    \"auto_navigate_to_play_details\": true,\n                    \"field_of_play_enabled\": false,\n                    \"game_misconduct_time\": 0,\n                    \"ice_hockey_goalie_order_by\": null,\n                    \"ice_hockey_goalie_order_by_secondary\": null,\n                    \"ice_hockey_goalie_order_dir\": null,\n                    \"ice_hockey_goalie_order_dir_secondary\": null,\n                    \"ice_hockey_goalie_stat_qualify_by\": null,\n                    \"ice_hockey_goalie_stat_qualify_val\": null,\n                    \"ice_hockey_skater_order_by\": null,\n                    \"ice_hockey_skater_order_by_secondary\": null,\n                    \"ice_hockey_skater_order_dir\": null,\n                    \"ice_hockey_skater_order_dir_secondary\": null,\n                    \"ice_hockey_skater_stat_qualify_by\": null,\n                    \"ice_hockey_skater_stat_qualify_val\": null,\n                    \"ice_hockey_team_scoring_order_by\": \"pts\",\n                    \"ice_hockey_team_scoring_order_by_secondary\": null,\n                    \"ice_hockey_team_scoring_order_dir\": \"desc\",\n                    \"ice_hockey_team_scoring_order_dir_secondary\": null,\n                    \"ice_hockey_team_scoring_stat_qualify_by\": null,\n                    \"ice_hockey_team_scoring_stat_qualify_val\": null,\n                    \"ice_hockey_team_stats_order_by\": null,\n                    \"ice_hockey_team_stats_order_by_secondary\": null,\n                    \"ice_hockey_team_stats_order_dir\": null,\n                    \"ice_hockey_team_stats_order_dir_secondary\": null,\n                    \"ice_hockey_team_stats_stat_qualify_by\": null,\n                    \"ice_hockey_team_stats_stat_qualify_val\": null,\n                    \"intermission_length\": 1,\n                    \"major_adjustment_time\": 0,\n                    \"major_penalty_time\": 5,\n                    \"match_penalty_time\": 5,\n                    \"max_goal_differential\": 0,\n                    \"max_player_major_penalties\": 2,\n                    \"max_player_penalties\": 5,\n                    \"max_team_penalties\": 15,\n                    \"minor_adjustment_time\": 0,\n                    \"minor_penalty_time\": 2,\n                    \"misconduct_time\": 10,\n                    \"overtime_intervals\": 2,\n                    \"overtime_length\": \"5\",\n                    \"post_live_updates\": true,\n                    \"regulation_time_intervals\": null,\n                    \"shootout_enabled\": false,\n                    \"stop_run_time\": true,\n                    \"time_interval_name\": \"period\",\n                    \"time_intervals\": [\n                        \"20\",\n                        \"20\",\n                        \"20\"\n                    ],\n                    \"timeout_time\": 1,\n                    \"timeouts\": 1,\n                    \"track_goal_types\": true,\n                    \"track_player_sog\": true,\n                    \"warmup_length\": 5\n                },\n                \"season_id\": 267440,\n                \"original_scorer_can_edit\": null,\n                \"force_real_time_scoring\": false,\n                \"stat_tool_id\": 1848623,\n                \"stats_can_be_unlinked\": null,\n                \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n                \"can_edit_final\": \"league_owner\",\n                \"traded_player_stats\": null,\n                \"game_sheet_auto_summary_enabled\": true,\n                \"visible_stats\": \"league_xor_division\"\n            },\n            \"subseasons\": [\n                {\n                    \"id\": 291621,\n                    \"name\": \"Regular Season\",\n                    \"season_id\": 267440,\n                    \"position\": 1,\n                    \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                    \"updated_at\": \"2016-04-20T09:47:22-07:00\",\n                    \"snl_scoring_enabled\": true,\n                    \"statistic_grouping_id\": 417884,\n                    \"workers_completed\": null,\n                    \"standing_preference\": {\n                        \"id\": 110425,\n                        \"standing_tool_id\": 1848627,\n                        \"standing_type_id\": 5,\n                        \"standings_aggregation_level\": \"league\",\n                        \"qualifiers\": null,\n                        \"qualifier_limit\": null,\n                        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"winning_team_custom_points\": null,\n                        \"losing_team_custom_points\": null,\n                        \"tied_team_custom_points\": null,\n                        \"label_mapping\": {},\n                        \"extended_fields\": [\n                            \"win_count\",\n                            \"loss_count\",\n                            \"tie_count\",\n                            \"points\"\n                        ],\n                        \"order_rule\": 1,\n                        \"overtime_win_custom_points\": null,\n                        \"overtime_loss_custom_points\": null,\n                        \"overtime_wins_include_in_wins\": true,\n                        \"overtime_losses_include_in_losses\": true,\n                        \"legacy_custom_points\": false\n                    },\n                    \"live_scoring_stat_configuration\": {\n                        \"show_plus_minus\": null,\n                        \"fair_play_points\": false\n                    }\n                }\n            ]\n        }\n    ],\n    \"subseason_team_instance_mapping\": [\n        {\n            \"subseason_id\": 291621,\n            \"team_instance_id\": 1876243\n        }\n    ],\n    \"league_name\": \"Eastern League\",\n    \"site_name\": \"Sport Ngin API Demo Site\",\n    \"sport_name\": \"Ice Hockey\",\n    \"team_instances\": [\n        {\n            \"abbrev\": \"Bos\",\n            \"affects_standings\": true,\n            \"button_title\": \"Boston\",\n            \"created_at\": \"2016-03-22T13:19:12-07:00\",\n            \"gender\": \"male\",\n            \"id\": 1876243,\n            \"image_id\": null,\n            \"management_team_id\": null,\n            \"name\": \"Boston Bears\",\n            \"opponent\": null,\n            \"parent_team_instance_id\": null,\n            \"primary_color\": \"000000\",\n            \"roster_id\": 1837158,\n            \"secondary_color\": \"000000\",\n            \"team_id\": 1373611,\n            \"updated_at\": \"2016-03-23T09:34:28-07:00\"\n        }\n    ]\n}"}]},"settings":"","url":"/teams/:id","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/teams/1373611\""},{"code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/teams/1373611\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body","language":"ruby"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/teams/1373611\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get"},"link_external":false,"link_url":"","user":"56548c568975c70d002ea4b4","childrenPages":[]}

getTeams Show

The Show method returns a single Team for a given `id`. ###Parameters

Path Params

id:

required

integer

Id of the team

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/teams/1373611"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/teams/1373611")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/teams/1373611")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1373611,
    "name": "Boston Bears",
    "button_title": "Boston",
    "abbrev": "Bos",
    "image_id": null,
    "primary_color": "000000",
    "secondary_color": "000000",
    "gender": "male",
    "created_at": "2016-03-22T13:06:41-07:00",
    "updated_at": "2016-03-23T09:34:28-07:00",
    "sport_id": 1,
    "opponent": null,
    "parent_team_id": null,
    "ios_whitelabel_url": null,
    "android_whitelabel_url": null,
    "sites": [
        {
            "id": 11953,
            "domain_id": 1149,
            "domain_name": "sportngin.com",
            "subdomain": "apidemo",
            "product_id": 14,
            "name": "Sport Ngin API Demo Site",
            "short_name": "Sport Ngin API Demo Site",
            "created_on": "2016-02-24T06:32:26-08:00",
            "updated_on": "2016-04-19T10:52:59-07:00",
            "created_by_user_id": 3156422,
            "updated_by_user_id": null,
            "timezone": "US/Central",
            "twitter_user_id": null,
            "layout_theme_id": 51,
            "secure_subdomain": "apidemo",
            "address_id": 4447713,
            "membership_privacy": "open",
            "membership_grace_period": 1,
            "boss_billing_account_id": null,
            "boss_organization_id": 27743
        }
    ],
    "leagues": [
        {
            "id": 27737,
            "name": "Eastern League",
            "current_subseason_id": 291621,
            "site_id": 11953,
            "sport_id": 1,
            "image_id": null,
            "created_at": "2016-03-22T12:46:58-07:00",
            "updated_at": "2016-03-24T07:20:49-07:00",
            "button_title": "Eastern",
            "primary_color": "00AEEF",
            "secondary_color": "666666",
            "gender": "male",
            "abbrev": "East",
            "score_ribbon": false,
            "tweet_games": null,
            "game_sheet_label": "gamesheet"
        }
    ],
    "thumbnails": {},
    "thumbnails_ssl": {},
    "current_subseason_ids": [
        291621
    ],
    "seasons": [
        {
            "id": 267440,
            "name": "2016",
            "created_at": "2016-03-22T12:46:58-07:00",
            "updated_at": "2016-03-22T12:46:58-07:00",
            "solo_team_league_id": null,
            "has_metadata": null,
            "show_shared_schedule": false,
            "stat_preference": {
                "id": 292407,
                "updated_on": "2016-03-22T12:46:58-07:00",
                "created_on": "2016-03-22T12:46:58-07:00",
                "game_defaults": {
                    "auto_navigate_to_play_details": true,
                    "field_of_play_enabled": false,
                    "game_misconduct_time": 0,
                    "ice_hockey_goalie_order_by": null,
                    "ice_hockey_goalie_order_by_secondary": null,
                    "ice_hockey_goalie_order_dir": null,
                    "ice_hockey_goalie_order_dir_secondary": null,
                    "ice_hockey_goalie_stat_qualify_by": null,
                    "ice_hockey_goalie_stat_qualify_val": null,
                    "ice_hockey_skater_order_by": null,
                    "ice_hockey_skater_order_by_secondary": null,
                    "ice_hockey_skater_order_dir": null,
                    "ice_hockey_skater_order_dir_secondary": null,
                    "ice_hockey_skater_stat_qualify_by": null,
                    "ice_hockey_skater_stat_qualify_val": null,
                    "ice_hockey_team_scoring_order_by": "pts",
                    "ice_hockey_team_scoring_order_by_secondary": null,
                    "ice_hockey_team_scoring_order_dir": "desc",
                    "ice_hockey_team_scoring_order_dir_secondary": null,
                    "ice_hockey_team_scoring_stat_qualify_by": null,
                    "ice_hockey_team_scoring_stat_qualify_val": null,
                    "ice_hockey_team_stats_order_by": null,
                    "ice_hockey_team_stats_order_by_secondary": null,
                    "ice_hockey_team_stats_order_dir": null,
                    "ice_hockey_team_stats_order_dir_secondary": null,
                    "ice_hockey_team_stats_stat_qualify_by": null,
                    "ice_hockey_team_stats_stat_qualify_val": null,
                    "intermission_length": 1,
                    "major_adjustment_time": 0,
                    "major_penalty_time": 5,
                    "match_penalty_time": 5,
                    "max_goal_differential": 0,
                    "max_player_major_penalties": 2,
                    "max_player_penalties": 5,
                    "max_team_penalties": 15,
                    "minor_adjustment_time": 0,
                    "minor_penalty_time": 2,
                    "misconduct_time": 10,
                    "overtime_intervals": 2,
                    "overtime_length": "5",
                    "post_live_updates": true,
                    "regulation_time_intervals": null,
                    "shootout_enabled": false,
                    "stop_run_time": true,
                    "time_interval_name": "period",
                    "time_intervals": [
                        "20",
                        "20",
                        "20"
                    ],
                    "timeout_time": 1,
                    "timeouts": 1,
                    "track_goal_types": true,
                    "track_player_sog": true,
                    "warmup_length": 5
                },
                "season_id": 267440,
                "original_scorer_can_edit": null,
                "force_real_time_scoring": false,
                "stat_tool_id": 1848623,
                "stats_can_be_unlinked": null,
                "scoring_methods": "--- \n- live\n- mass\n- tabular\n- quick\n",
                "can_edit_final": "league_owner",
                "traded_player_stats": null,
                "game_sheet_auto_summary_enabled": true,
                "visible_stats": "league_xor_division"
            },
            "subseasons": [
                {
                    "id": 291621,
                    "name": "Regular Season",
                    "season_id": 267440,
                    "position": 1,
                    "created_at": "2016-03-22T12:46:58-07:00",
                    "updated_at": "2016-04-20T09:47:22-07:00",
                    "snl_scoring_enabled": true,
                    "statistic_grouping_id": 417884,
                    "workers_completed": null,
                    "standing_preference": {
                        "id": 110425,
                        "standing_tool_id": 1848627,
                        "standing_type_id": 5,
                        "standings_aggregation_level": "league",
                        "qualifiers": null,
                        "qualifier_limit": null,
                        "created_at": "2016-03-22T12:46:58-07:00",
                        "updated_at": "2016-03-22T12:46:58-07:00",
                        "winning_team_custom_points": null,
                        "losing_team_custom_points": null,
                        "tied_team_custom_points": null,
                        "label_mapping": {},
                        "extended_fields": [
                            "win_count",
                            "loss_count",
                            "tie_count",
                            "points"
                        ],
                        "order_rule": 1,
                        "overtime_win_custom_points": null,
                        "overtime_loss_custom_points": null,
                        "overtime_wins_include_in_wins": true,
                        "overtime_losses_include_in_losses": true,
                        "legacy_custom_points": false
                    },
                    "live_scoring_stat_configuration": {
                        "show_plus_minus": null,
                        "fair_play_points": false
                    }
                }
            ]
        }
    ],
    "subseason_team_instance_mapping": [
        {
            "subseason_id": 291621,
            "team_instance_id": 1876243
        }
    ],
    "league_name": "Eastern League",
    "site_name": "Sport Ngin API Demo Site",
    "sport_name": "Ice Hockey",
    "team_instances": [
        {
            "abbrev": "Bos",
            "affects_standings": true,
            "button_title": "Boston",
            "created_at": "2016-03-22T13:19:12-07:00",
            "gender": "male",
            "id": 1876243,
            "image_id": null,
            "management_team_id": null,
            "name": "Boston Bears",
            "opponent": null,
            "parent_team_instance_id": null,
            "primary_color": "000000",
            "roster_id": 1837158,
            "secondary_color": "000000",
            "team_id": 1373611,
            "updated_at": "2016-03-23T09:34:28-07:00"
        }
    ]
}

{"_id":"577e8f45a74eb40e00d97b61","isReference":true,"link_url":"","githubsync":"","order":13,"project":"5641217e0ee5370d00da636d","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X PUT -H \"Authorization: Bearer ACCESS_TOKEN  \" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '\n{\n   \"abbrev\": \"BBB\" \n}\n' \"https://api.sportngin.com/teams/1373611\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/teams/1373611\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"team\\\":\\n    {\\n        \\\"abbrev\\\": \\\"BBB\\\" \\n    }\\n}\"\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"team\\\":\\n    {\\n        \\\"abbrev\\\": \\\"BBB\\\" \\n    }\\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/teams/1373611\")\n  .put(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"put","params":[{"_id":"577e8f45a74eb40e00d97b62","ref":"","in":"path","required":true,"desc":"Id of team to update","default":"","type":"int","name":"id"}],"results":{"codes":[{"name":"","code":"{\n    \"id\": 1373611,\n    \"name\": \"Boston Bears\",\n    \"button_title\": \"Boston\",\n    \"abbrev\": \"BBB\",\n    \"image_id\": null,\n    \"primary_color\": \"000000\",\n    \"secondary_color\": \"000000\",\n    \"gender\": \"male\",\n    \"created_at\": \"2016-03-22T13:06:41-07:00\",\n    \"updated_at\": \"2016-07-07T10:16:51-07:00\",\n    \"sport_id\": 1,\n    \"opponent\": null,\n    \"parent_team_id\": null,\n    \"ios_whitelabel_url\": null,\n    \"android_whitelabel_url\": null,\n    \"sites\": [\n        {\n            \"id\": 11953,\n            \"domain_id\": 1149,\n            \"domain_name\": \"sportngin.com\",\n            \"subdomain\": \"apidemo\",\n            \"product_id\": 14,\n            \"name\": \"Sport Ngin API Demo Site\",\n            \"short_name\": \"Sport Ngin API Demo Site\",\n            \"created_on\": \"2016-02-24T06:32:26-08:00\",\n            \"updated_on\": \"2016-06-02T09:24:42-07:00\",\n            \"created_by_user_id\": 3156422,\n            \"updated_by_user_id\": 3646297,\n            \"timezone\": \"America/Chicago\",\n            \"twitter_user_id\": null,\n            \"layout_theme_id\": 53,\n            \"secure_subdomain\": \"apidemo\",\n            \"address_id\": 4447713,\n            \"membership_privacy\": \"open\",\n            \"membership_grace_period\": 1,\n            \"boss_billing_account_id\": null,\n            \"boss_organization_id\": 27743\n        }\n    ],\n    \"leagues\": [\n        {\n            \"id\": 27737,\n            \"name\": \"Eastern League\",\n            \"current_subseason_id\": 291621,\n            \"site_id\": 11953,\n            \"sport_id\": 1,\n            \"image_id\": null,\n            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n            \"updated_at\": \"2016-05-02T13:29:58-07:00\",\n            \"button_title\": \"Eastern\",\n            \"primary_color\": \"00AEEF\",\n            \"secondary_color\": \"666666\",\n            \"gender\": \"male\",\n            \"abbrev\": \"East\",\n            \"score_ribbon\": false,\n            \"tweet_games\": null,\n            \"game_sheet_label\": \"gamesheet\"\n        }\n    ],\n    \"thumbnails\": {},\n    \"thumbnails_ssl\": {},\n    \"current_subseason_ids\": [\n        291621\n    ],\n    \"seasons\": [\n        {\n            \"id\": 267440,\n...\n    ],\n    \"subseason_team_instance_mapping\": [\n        {\n            \"subseason_id\": 291621,\n            \"team_instance_id\": 1876243\n        },\n        {\n            \"subseason_id\": 302608,\n            \"team_instance_id\": 1979872\n        }\n    ],\n    \"league_name\": \"Eastern League\",\n    \"site_name\": \"Sport Ngin API Demo Site\",\n    \"sport_name\": \"Ice Hockey\"\n}","language":"json","status":200}]},"settings":"","url":"/teams/:id"},"body":"","slug":"teams-update","user":"56548c568975c70d002ea4b4","__v":1,"editedParams2":true,"link_external":false,"excerpt":"The Update method updates the provided fields for a given `id`.\n\n###Parameters","hidden":false,"parentDoc":null,"sync_unique":"","title":"Teams Update","category":"56e03709f97d422900d63922","createdAt":"2016-07-07T17:20:05.025Z","editedParams":true,"type":"put","updates":[],"version":"56cca51eca43550b002813fa","next":{"description":"","pages":[]},"childrenPages":[]}

putTeams Update

The Update method updates the provided fields for a given `id`. ###Parameters

Path Params

id:

required

integer

Id of team to update

Definition

Examples

curl -X PUT -H "Authorization: Bearer ACCESS_TOKEN  " -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '
{
   "abbrev": "BBB" 
}
' "https://api.sportngin.com/teams/1373611"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/teams/1373611")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"team\":\n    {\n        \"abbrev\": \"BBB\" \n    }\n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"team\":\n    {\n        \"abbrev\": \"BBB\" \n    }\n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/teams/1373611")
  .put(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1373611,
    "name": "Boston Bears",
    "button_title": "Boston",
    "abbrev": "BBB",
    "image_id": null,
    "primary_color": "000000",
    "secondary_color": "000000",
    "gender": "male",
    "created_at": "2016-03-22T13:06:41-07:00",
    "updated_at": "2016-07-07T10:16:51-07:00",
    "sport_id": 1,
    "opponent": null,
    "parent_team_id": null,
    "ios_whitelabel_url": null,
    "android_whitelabel_url": null,
    "sites": [
        {
            "id": 11953,
            "domain_id": 1149,
            "domain_name": "sportngin.com",
            "subdomain": "apidemo",
            "product_id": 14,
            "name": "Sport Ngin API Demo Site",
            "short_name": "Sport Ngin API Demo Site",
            "created_on": "2016-02-24T06:32:26-08:00",
            "updated_on": "2016-06-02T09:24:42-07:00",
            "created_by_user_id": 3156422,
            "updated_by_user_id": 3646297,
            "timezone": "America/Chicago",
            "twitter_user_id": null,
            "layout_theme_id": 53,
            "secure_subdomain": "apidemo",
            "address_id": 4447713,
            "membership_privacy": "open",
            "membership_grace_period": 1,
            "boss_billing_account_id": null,
            "boss_organization_id": 27743
        }
    ],
    "leagues": [
        {
            "id": 27737,
            "name": "Eastern League",
            "current_subseason_id": 291621,
            "site_id": 11953,
            "sport_id": 1,
            "image_id": null,
            "created_at": "2016-03-22T12:46:58-07:00",
            "updated_at": "2016-05-02T13:29:58-07:00",
            "button_title": "Eastern",
            "primary_color": "00AEEF",
            "secondary_color": "666666",
            "gender": "male",
            "abbrev": "East",
            "score_ribbon": false,
            "tweet_games": null,
            "game_sheet_label": "gamesheet"
        }
    ],
    "thumbnails": {},
    "thumbnails_ssl": {},
    "current_subseason_ids": [
        291621
    ],
    "seasons": [
        {
            "id": 267440,
...
    ],
    "subseason_team_instance_mapping": [
        {
            "subseason_id": 291621,
            "team_instance_id": 1876243
        },
        {
            "subseason_id": 302608,
            "team_instance_id": 1979872
        }
    ],
    "league_name": "Eastern League",
    "site_name": "Sport Ngin API Demo Site",
    "sport_name": "Ice Hockey"
}

{"_id":"56d8802947b99513001f77b4","parentDoc":null,"project":"5641217e0ee5370d00da636d","api":{"url":"/team_instances","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/team_instances?subseason_id=291621\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances?subseason_id=291621\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances?subseason_id=291621\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"}]},"method":"get","params":[{"_id":"56d882d2b159f10b003045fc","ref":"","in":"query","required":false,"desc":"Id of Subseason","default":"","type":"int","name":"subseason_id"},{"_id":"56d882d2b159f10b003045fb","ref":"","in":"query","required":false,"desc":"Id of LeagueInstance","default":"","type":"int","name":"league_instance_id"}],"results":{"codes":[{"name":"","code":"[\n    {\n        \"id\": 1876243,\n        \"created_at\": \"2016-03-22T13:19:12-07:00\",\n        \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n        \"team_id\": 1373611,\n        \"affects_standings\": true,\n        \"name\": \"Boston Bears\",\n        \"roster_id\": 1837158,\n        \"opponent\": null,\n        \"parent_team_instance_id\": null,\n        \"image_id\": null,\n        \"abbrev\": \"Bos\",\n        \"primary_color\": \"000000\",\n        \"secondary_color\": \"000000\",\n        \"button_title\": \"Boston\",\n        \"gender\": \"male\",\n        \"management_team_id\": null,\n        \"team\": {\n            \"id\": 1373611,\n            \"name\": \"Boston Bears\",\n            \"button_title\": \"Boston\",\n            \"abbrev\": \"Bos\",\n            \"image_id\": null,\n            \"primary_color\": \"000000\",\n            \"secondary_color\": \"000000\",\n            \"gender\": \"male\",\n            \"created_at\": \"2016-03-22T13:06:41-07:00\",\n            \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n            \"sport_id\": 1,\n            \"opponent\": null,\n            \"parent_team_id\": null,\n            \"ios_whitelabel_url\": null,\n            \"android_whitelabel_url\": null,\n            \"sites\": [\n                {\n                    \"id\": 11953,\n                    \"domain_id\": 1149,\n                    \"domain_name\": \"sportngin.com\",\n                    \"subdomain\": \"apidemo\",\n                    \"product_id\": 14,\n                    \"name\": \"Sport Ngin API Demo Site\",\n                    \"short_name\": \"Sport Ngin API Demo Site\",\n                    \"created_on\": \"2016-02-24T06:32:26-08:00\",\n                    \"updated_on\": \"2016-04-08T10:04:54-07:00\",\n                    \"created_by_user_id\": 3156422,\n                    \"updated_by_user_id\": null,\n                    \"timezone\": \"US/Central\",\n                    \"twitter_user_id\": null,\n                    \"layout_theme_id\": 51,\n                    \"secure_subdomain\": \"apidemo\",\n                    \"address_id\": 4447713,\n                    \"membership_privacy\": \"open\",\n                    \"membership_grace_period\": 1,\n                    \"boss_billing_account_id\": null,\n                    \"boss_organization_id\": 27743\n                }\n            ],\n            \"leagues\": [\n                {\n                    \"id\": 27737,\n                    \"name\": \"Eastern League\",\n                    \"current_subseason_id\": 291621,\n                    \"site_id\": 11953,\n                    \"sport_id\": 1,\n                    \"image_id\": null,\n                    \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                    \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n                    \"button_title\": \"Eastern\",\n                    \"primary_color\": \"00AEEF\",\n                    \"secondary_color\": \"666666\",\n                    \"gender\": \"male\",\n                    \"abbrev\": \"East\",\n                    \"score_ribbon\": false,\n                    \"tweet_games\": null,\n                    \"game_sheet_label\": \"gamesheet\"\n                }\n            ],\n            \"thumbnails\": {},\n            \"thumbnails_ssl\": {},\n            \"current_subseason_ids\": [\n                291621\n            ],\n            \"seasons\": [\n                {\n                    \"id\": 267440,\n                    \"name\": \"2016\",\n                    \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                    \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                    \"solo_team_league_id\": null,\n                    \"has_metadata\": null,\n                    \"show_shared_schedule\": false,\n                    \"stat_preference\": {\n                        \"id\": 292407,\n                        \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n                        \"created_on\": \"2016-03-22T12:46:58-07:00\",\n                        \"game_defaults\": {\n                            \"auto_navigate_to_play_details\": true,\n                            \"field_of_play_enabled\": false,\n                            \"game_misconduct_time\": 0,\n                            \"ice_hockey_goalie_order_by\": null,\n                            \"ice_hockey_goalie_order_by_secondary\": null,\n                            \"ice_hockey_goalie_order_dir\": null,\n                            \"ice_hockey_goalie_order_dir_secondary\": null,\n                            \"ice_hockey_goalie_stat_qualify_by\": null,\n                            \"ice_hockey_goalie_stat_qualify_val\": null,\n                            \"ice_hockey_skater_order_by\": null,\n                            \"ice_hockey_skater_order_by_secondary\": null,\n                            \"ice_hockey_skater_order_dir\": null,\n                            \"ice_hockey_skater_order_dir_secondary\": null,\n                            \"ice_hockey_skater_stat_qualify_by\": null,\n                            \"ice_hockey_skater_stat_qualify_val\": null,\n                            \"ice_hockey_team_scoring_order_by\": \"pts\",\n                            \"ice_hockey_team_scoring_order_by_secondary\": null,\n                            \"ice_hockey_team_scoring_order_dir\": \"desc\",\n                            \"ice_hockey_team_scoring_order_dir_secondary\": null,\n                            \"ice_hockey_team_scoring_stat_qualify_by\": null,\n                            \"ice_hockey_team_scoring_stat_qualify_val\": null,\n                            \"ice_hockey_team_stats_order_by\": null,\n                            \"ice_hockey_team_stats_order_by_secondary\": null,\n                            \"ice_hockey_team_stats_order_dir\": null,\n                            \"ice_hockey_team_stats_order_dir_secondary\": null,\n                            \"ice_hockey_team_stats_stat_qualify_by\": null,\n                            \"ice_hockey_team_stats_stat_qualify_val\": null,\n                            \"intermission_length\": 1,\n                            \"major_adjustment_time\": 0,\n                            \"major_penalty_time\": 5,\n                            \"match_penalty_time\": 5,\n                            \"max_goal_differential\": 0,\n                            \"max_player_major_penalties\": 2,\n                            \"max_player_penalties\": 5,\n                            \"max_team_penalties\": 15,\n                            \"minor_adjustment_time\": 0,\n                            \"minor_penalty_time\": 2,\n                            \"misconduct_time\": 10,\n                            \"overtime_intervals\": 2,\n                            \"overtime_length\": \"5\",\n                            \"post_live_updates\": true,\n                            \"regulation_time_intervals\": null,\n                            \"shootout_enabled\": false,\n                            \"stop_run_time\": true,\n                            \"time_interval_name\": \"period\",\n                            \"time_intervals\": [\n                                \"20\",\n                                \"20\",\n                                \"20\"\n                            ],\n                            \"timeout_time\": 1,\n                            \"timeouts\": 1,\n                            \"track_goal_types\": true,\n                            \"track_player_sog\": true,\n                            \"warmup_length\": 5\n                        },\n                        \"season_id\": 267440,\n                        \"original_scorer_can_edit\": null,\n                        \"force_real_time_scoring\": false,\n                        \"stat_tool_id\": 1848623,\n                        \"stats_can_be_unlinked\": null,\n                        \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n                        \"can_edit_final\": \"league_owner\",\n                        \"traded_player_stats\": null,\n                        \"game_sheet_auto_summary_enabled\": true,\n                        \"visible_stats\": \"league_xor_division\"\n                    },\n                    \"subseasons\": [\n                        {\n                            \"id\": 291621,\n                            \"name\": \"Regular Season\",\n                            \"season_id\": 267440,\n                            \"position\": 1,\n                            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"updated_at\": \"2016-04-15T11:02:33-07:00\",\n                            \"snl_scoring_enabled\": true,\n                            \"statistic_grouping_id\": 417884,\n                            \"workers_completed\": null,\n                            \"standing_preference\": {\n                                \"id\": 110425,\n                                \"standing_tool_id\": 1848627,\n                                \"standing_type_id\": 5,\n                                \"standings_aggregation_level\": \"league\",\n                                \"qualifiers\": null,\n                                \"qualifier_limit\": null,\n                                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                                \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                                \"winning_team_custom_points\": null,\n                                \"losing_team_custom_points\": null,\n                                \"tied_team_custom_points\": null,\n                                \"label_mapping\": {},\n                                \"extended_fields\": [\n                                    \"win_count\",\n                                    \"loss_count\",\n                                    \"tie_count\",\n                                    \"points\"\n                                ],\n                                \"order_rule\": 1,\n                                \"overtime_win_custom_points\": null,\n                                \"overtime_loss_custom_points\": null,\n                                \"overtime_wins_include_in_wins\": true,\n                                \"overtime_losses_include_in_losses\": true,\n                                \"legacy_custom_points\": false\n                            },\n                            \"live_scoring_stat_configuration\": {\n                                \"show_plus_minus\": null,\n                                \"fair_play_points\": false\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"subseason_team_instance_mapping\": [\n                {\n                    \"subseason_id\": 291621,\n                    \"team_instance_id\": 1876243\n                }\n            ],\n            \"league_name\": \"Eastern League\",\n            \"site_name\": \"Sport Ngin API Demo Site\",\n            \"sport_name\": \"Ice Hockey\"\n        },\n        \"thumbnails\": {},\n        \"subseason_ids\": [\n            291621\n        ]\n    },\n    \n...\n]","language":"json","status":200}]},"settings":""},"githubsync":"","hidden":false,"link_external":false,"link_url":"","__v":4,"sync_unique":"","title":"Team Instances Index","version":"56cca51eca43550b002813fa","body":"###Attributes \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"created_at\",\n    \"2-0\": \"updated_at\",\n    \"3-0\": \"team_id\",\n    \"4-0\": \"affects_standings\",\n    \"5-0\": \"name\",\n    \"6-0\": \"roster_id\",\n    \"7-0\": \"opponent\",\n    \"8-0\": \"parent_team_instance_id\",\n    \"9-0\": \"image_id\",\n    \"10-0\": \"abbrev\",\n    \"13-0\": \"button_title\",\n    \"14-0\": \"gender\",\n    \"11-0\": \"primary_color\",\n    \"12-0\": \"secondary_color\",\n    \"15-0\": \"team\",\n    \"16-0\": \"thumbnails\",\n    \"17-0\": \"subseason_ids\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Id of TeamInstance\",\n    \"1-1\": \"Timestamp\",\n    \"2-2\": \"Timestamp of last update\",\n    \"1-2\": \"Timestamp when created\",\n    \"2-1\": \"Timestamp\",\n    \"3-1\": \"Integer\",\n    \"3-2\": \"Id of team\",\n    \"4-1\": \"Boolean\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Name of team\",\n    \"6-1\": \"Integer\",\n    \"6-2\": \"Id of roster that belongs to this TeamInstance\",\n    \"7-1\": \"Boolean\",\n    \"8-1\": \"Integer\",\n    \"9-1\": \"Integer\",\n    \"10-1\": \"String\",\n    \"11-1\": \"String\",\n    \"12-1\": \"String\",\n    \"13-1\": \"String\",\n    \"14-1\": \"String\",\n    \"15-1\": \"Object\",\n    \"16-1\": \"Object\",\n    \"17-1\": \"Array\",\n    \"4-2\": \"Determines if this TeamInstance affects standings for the league\",\n    \"7-2\": \"Determines if this TeamInstance is an opponent for a SoloTeamLeague\",\n    \"8-2\": \"If opponent is true, this is the id of the TeamInstance that this TeamInstance is an opponent of\",\n    \"9-2\": \"Id of Image\",\n    \"10-2\": \"Abbreviation of this TeamInstance\",\n    \"11-2\": \"Primary color used in styling of team pages\",\n    \"12-2\": \"Secondary color used in styling of team pages\",\n    \"13-2\": \"Abbreviation of team. Used in various locations that have limited text.\",\n    \"14-2\": \"Gender of team (male, female, co-ed)\",\n    \"17-2\": \"Ids of Subseasons that this TeamInstance belongs to\",\n    \"16-2\": \"Object with relative links to large, medium, and small thumbnails (derived)\",\n    \"15-2\": \"Object representing the team irrespective of season or subseason\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]","editedParams":true,"slug":"team-instances-index","updates":[],"user":"569e96c56b4a2c0d007e9153","type":"get","category":"56e03709f97d422900d63922","createdAt":"2016-03-03T18:19:21.971Z","editedParams2":true,"excerpt":"The Index method returns an array of Team Instances matching the given parameters.  This endpoint requires at least one parameter: either `subseason_id` or `league_instance_id`.\n\nA list of team instances belonging to the provided [League](https://sportnginv2.readme.io/docs/leagues) or [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) is returned.  An error is thrown if any of the parameters are invalid.\n\n###Parameters","isReference":true,"order":15,"next":{"description":"","pages":[]},"childrenPages":[]}

getTeam Instances Index

The Index method returns an array of Team Instances matching the given parameters. This endpoint requires at least one parameter: either `subseason_id` or `league_instance_id`. A list of team instances belonging to the provided [League](https://sportnginv2.readme.io/docs/leagues) or [Subseason](https://sportnginv2.readme.io/docs/subseasons-show) is returned. An error is thrown if any of the parameters are invalid. ###Parameters

Query Params

subseason_id:

integer

Id of Subseason

league_instance_id:

integer

Id of LeagueInstance

Attributes

Name

Type

Description

Integer

Id of TeamInstance

created_at

Timestamp

Timestamp when created

updated_at

Timestamp

Timestamp of last update

team_id

Integer

Id of team

affects_standings

Boolean

Determines if this TeamInstance affects standings for the league

name

String

Name of team

roster_id

Integer

Id of roster that belongs to this TeamInstance

opponent

Boolean

Determines if this TeamInstance is an opponent for a SoloTeamLeague

parent_team_instance_id

Integer

If opponent is true, this is the id of the TeamInstance that this TeamInstance is an opponent of

image_id

Integer

Id of Image

abbrev

String

Abbreviation of this TeamInstance

primary_color

String

Primary color used in styling of team pages

secondary_color

String

Secondary color used in styling of team pages

button_title

String

Abbreviation of team. Used in various locations that have limited text.

gender

String

Gender of team (male, female, co-ed)

team

Object

Object representing the team irrespective of season or subseason

thumbnails

Object

Object with relative links to large, medium, and small thumbnails (derived)

subseason_ids

Array

Ids of Subseasons that this TeamInstance belongs to

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/team_instances?subseason_id=291621"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances?subseason_id=291621")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances?subseason_id=291621")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

[
    {
        "id": 1876243,
        "created_at": "2016-03-22T13:19:12-07:00",
        "updated_at": "2016-03-23T09:34:28-07:00",
        "team_id": 1373611,
        "affects_standings": true,
        "name": "Boston Bears",
        "roster_id": 1837158,
        "opponent": null,
        "parent_team_instance_id": null,
        "image_id": null,
        "abbrev": "Bos",
        "primary_color": "000000",
        "secondary_color": "000000",
        "button_title": "Boston",
        "gender": "male",
        "management_team_id": null,
        "team": {
            "id": 1373611,
            "name": "Boston Bears",
            "button_title": "Boston",
            "abbrev": "Bos",
            "image_id": null,
            "primary_color": "000000",
            "secondary_color": "000000",
            "gender": "male",
            "created_at": "2016-03-22T13:06:41-07:00",
            "updated_at": "2016-03-23T09:34:28-07:00",
            "sport_id": 1,
            "opponent": null,
            "parent_team_id": null,
            "ios_whitelabel_url": null,
            "android_whitelabel_url": null,
            "sites": [
                {
                    "id": 11953,
                    "domain_id": 1149,
                    "domain_name": "sportngin.com",
                    "subdomain": "apidemo",
                    "product_id": 14,
                    "name": "Sport Ngin API Demo Site",
                    "short_name": "Sport Ngin API Demo Site",
                    "created_on": "2016-02-24T06:32:26-08:00",
                    "updated_on": "2016-04-08T10:04:54-07:00",
                    "created_by_user_id": 3156422,
                    "updated_by_user_id": null,
                    "timezone": "US/Central",
                    "twitter_user_id": null,
                    "layout_theme_id": 51,
                    "secure_subdomain": "apidemo",
                    "address_id": 4447713,
                    "membership_privacy": "open",
                    "membership_grace_period": 1,
                    "boss_billing_account_id": null,
                    "boss_organization_id": 27743
                }
            ],
            "leagues": [
                {
                    "id": 27737,
                    "name": "Eastern League",
                    "current_subseason_id": 291621,
                    "site_id": 11953,
                    "sport_id": 1,
                    "image_id": null,
                    "created_at": "2016-03-22T12:46:58-07:00",
                    "updated_at": "2016-03-24T07:20:49-07:00",
                    "button_title": "Eastern",
                    "primary_color": "00AEEF",
                    "secondary_color": "666666",
                    "gender": "male",
                    "abbrev": "East",
                    "score_ribbon": false,
                    "tweet_games": null,
                    "game_sheet_label": "gamesheet"
                }
            ],
            "thumbnails": {},
            "thumbnails_ssl": {},
            "current_subseason_ids": [
                291621
            ],
            "seasons": [
                {
                    "id": 267440,
                    "name": "2016",
                    "created_at": "2016-03-22T12:46:58-07:00",
                    "updated_at": "2016-03-22T12:46:58-07:00",
                    "solo_team_league_id": null,
                    "has_metadata": null,
                    "show_shared_schedule": false,
                    "stat_preference": {
                        "id": 292407,
                        "updated_on": "2016-03-22T12:46:58-07:00",
                        "created_on": "2016-03-22T12:46:58-07:00",
                        "game_defaults": {
                            "auto_navigate_to_play_details": true,
                            "field_of_play_enabled": false,
                            "game_misconduct_time": 0,
                            "ice_hockey_goalie_order_by": null,
                            "ice_hockey_goalie_order_by_secondary": null,
                            "ice_hockey_goalie_order_dir": null,
                            "ice_hockey_goalie_order_dir_secondary": null,
                            "ice_hockey_goalie_stat_qualify_by": null,
                            "ice_hockey_goalie_stat_qualify_val": null,
                            "ice_hockey_skater_order_by": null,
                            "ice_hockey_skater_order_by_secondary": null,
                            "ice_hockey_skater_order_dir": null,
                            "ice_hockey_skater_order_dir_secondary": null,
                            "ice_hockey_skater_stat_qualify_by": null,
                            "ice_hockey_skater_stat_qualify_val": null,
                            "ice_hockey_team_scoring_order_by": "pts",
                            "ice_hockey_team_scoring_order_by_secondary": null,
                            "ice_hockey_team_scoring_order_dir": "desc",
                            "ice_hockey_team_scoring_order_dir_secondary": null,
                            "ice_hockey_team_scoring_stat_qualify_by": null,
                            "ice_hockey_team_scoring_stat_qualify_val": null,
                            "ice_hockey_team_stats_order_by": null,
                            "ice_hockey_team_stats_order_by_secondary": null,
                            "ice_hockey_team_stats_order_dir": null,
                            "ice_hockey_team_stats_order_dir_secondary": null,
                            "ice_hockey_team_stats_stat_qualify_by": null,
                            "ice_hockey_team_stats_stat_qualify_val": null,
                            "intermission_length": 1,
                            "major_adjustment_time": 0,
                            "major_penalty_time": 5,
                            "match_penalty_time": 5,
                            "max_goal_differential": 0,
                            "max_player_major_penalties": 2,
                            "max_player_penalties": 5,
                            "max_team_penalties": 15,
                            "minor_adjustment_time": 0,
                            "minor_penalty_time": 2,
                            "misconduct_time": 10,
                            "overtime_intervals": 2,
                            "overtime_length": "5",
                            "post_live_updates": true,
                            "regulation_time_intervals": null,
                            "shootout_enabled": false,
                            "stop_run_time": true,
                            "time_interval_name": "period",
                            "time_intervals": [
                                "20",
                                "20",
                                "20"
                            ],
                            "timeout_time": 1,
                            "timeouts": 1,
                            "track_goal_types": true,
                            "track_player_sog": true,
                            "warmup_length": 5
                        },
                        "season_id": 267440,
                        "original_scorer_can_edit": null,
                        "force_real_time_scoring": false,
                        "stat_tool_id": 1848623,
                        "stats_can_be_unlinked": null,
                        "scoring_methods": "--- \n- live\n- mass\n- tabular\n- quick\n",
                        "can_edit_final": "league_owner",
                        "traded_player_stats": null,
                        "game_sheet_auto_summary_enabled": true,
                        "visible_stats": "league_xor_division"
                    },
                    "subseasons": [
                        {
                            "id": 291621,
                            "name": "Regular Season",
                            "season_id": 267440,
                            "position": 1,
                            "created_at": "2016-03-22T12:46:58-07:00",
                            "updated_at": "2016-04-15T11:02:33-07:00",
                            "snl_scoring_enabled": true,
                            "statistic_grouping_id": 417884,
                            "workers_completed": null,
                            "standing_preference": {
                                "id": 110425,
                                "standing_tool_id": 1848627,
                                "standing_type_id": 5,
                                "standings_aggregation_level": "league",
                                "qualifiers": null,
                                "qualifier_limit": null,
                                "created_at": "2016-03-22T12:46:58-07:00",
                                "updated_at": "2016-03-22T12:46:58-07:00",
                                "winning_team_custom_points": null,
                                "losing_team_custom_points": null,
                                "tied_team_custom_points": null,
                                "label_mapping": {},
                                "extended_fields": [
                                    "win_count",
                                    "loss_count",
                                    "tie_count",
                                    "points"
                                ],
                                "order_rule": 1,
                                "overtime_win_custom_points": null,
                                "overtime_loss_custom_points": null,
                                "overtime_wins_include_in_wins": true,
                                "overtime_losses_include_in_losses": true,
                                "legacy_custom_points": false
                            },
                            "live_scoring_stat_configuration": {
                                "show_plus_minus": null,
                                "fair_play_points": false
                            }
                        }
                    ]
                }
            ],
            "subseason_team_instance_mapping": [
                {
                    "subseason_id": 291621,
                    "team_instance_id": 1876243
                }
            ],
            "league_name": "Eastern League",
            "site_name": "Sport Ngin API Demo Site",
            "sport_name": "Ice Hockey"
        },
        "thumbnails": {},
        "subseason_ids": [
            291621
        ]
    },
    
...
]

{"_id":"56f1bf659c88d00e00d9e495","api":{"params":[{"name":"id","in":"path","_id":"57114eae5ba0d80e00f51614","ref":"","required":true,"desc":"Id belonging to the team_instance of interest","default":"","type":"int"}],"results":{"codes":[{"language":"json","code":"{\n    \"id\": 1876243,\n    \"created_at\": \"2016-03-22T13:19:12-07:00\",\n    \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n    \"team_id\": 1373611,\n    \"affects_standings\": true,\n    \"name\": \"Boston Bears\",\n    \"roster_id\": 1837158,\n    \"opponent\": null,\n    \"parent_team_instance_id\": null,\n    \"image_id\": null,\n    \"abbrev\": \"Bos\",\n    \"primary_color\": \"000000\",\n    \"secondary_color\": \"000000\",\n    \"button_title\": \"Boston\",\n    \"gender\": \"male\",\n    \"management_team_id\": null,\n    \"team\": {\n        \"id\": 1373611,\n        \"name\": \"Boston Bears\",\n        \"button_title\": \"Boston\",\n        \"abbrev\": \"Bos\",\n        \"image_id\": null,\n        \"primary_color\": \"000000\",\n        \"secondary_color\": \"000000\",\n        \"gender\": \"male\",\n        \"created_at\": \"2016-03-22T13:06:41-07:00\",\n        \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n        \"sport_id\": 1,\n        \"opponent\": null,\n        \"parent_team_id\": null,\n        \"ios_whitelabel_url\": null,\n        \"android_whitelabel_url\": null,\n        \"sites\": [\n            {\n                \"id\": 11953,\n                \"domain_id\": 1149,\n                \"domain_name\": \"sportngin.com\",\n                \"subdomain\": \"apidemo\",\n                \"product_id\": 14,\n                \"name\": \"Sport Ngin API Demo Site\",\n                \"short_name\": \"Sport Ngin API Demo Site\",\n                \"created_on\": \"2016-02-24T06:32:26-08:00\",\n                \"updated_on\": \"2016-04-08T10:04:54-07:00\",\n                \"created_by_user_id\": 3156422,\n                \"updated_by_user_id\": null,\n                \"timezone\": \"US/Central\",\n                \"twitter_user_id\": null,\n                \"layout_theme_id\": 51,\n                \"secure_subdomain\": \"apidemo\",\n                \"address_id\": 4447713,\n                \"membership_privacy\": \"open\",\n                \"membership_grace_period\": 1,\n                \"boss_billing_account_id\": null,\n                \"boss_organization_id\": 27743\n            }\n        ],\n        \"leagues\": [\n            {\n                \"id\": 27737,\n                \"name\": \"Eastern League\",\n                \"current_subseason_id\": 291621,\n                \"site_id\": 11953,\n                \"sport_id\": 1,\n                \"image_id\": null,\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n                \"button_title\": \"Eastern\",\n                \"primary_color\": \"00AEEF\",\n                \"secondary_color\": \"666666\",\n                \"gender\": \"male\",\n                \"abbrev\": \"East\",\n                \"score_ribbon\": false,\n                \"tweet_games\": null,\n                \"game_sheet_label\": \"gamesheet\"\n            }\n        ],\n        \"thumbnails\": {},\n        \"thumbnails_ssl\": {},\n        \"current_subseason_ids\": [\n            291621\n        ],\n        \"seasons\": [\n            {\n                \"id\": 267440,\n                \"name\": \"2016\",\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                \"solo_team_league_id\": null,\n                \"has_metadata\": null,\n                \"show_shared_schedule\": false,\n                \"stat_preference\": {\n                    \"id\": 292407,\n                    \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"created_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"game_defaults\": {\n                        \"auto_navigate_to_play_details\": true,\n                        \"field_of_play_enabled\": false,\n                        \"game_misconduct_time\": 0,\n                        \"ice_hockey_goalie_order_by\": null,\n                        \"ice_hockey_goalie_order_by_secondary\": null,\n                        \"ice_hockey_goalie_order_dir\": null,\n                        \"ice_hockey_goalie_order_dir_secondary\": null,\n                        \"ice_hockey_goalie_stat_qualify_by\": null,\n                        \"ice_hockey_goalie_stat_qualify_val\": null,\n                        \"ice_hockey_skater_order_by\": null,\n                        \"ice_hockey_skater_order_by_secondary\": null,\n                        \"ice_hockey_skater_order_dir\": null,\n                        \"ice_hockey_skater_order_dir_secondary\": null,\n                        \"ice_hockey_skater_stat_qualify_by\": null,\n                        \"ice_hockey_skater_stat_qualify_val\": null,\n                        \"ice_hockey_team_scoring_order_by\": \"pts\",\n                        \"ice_hockey_team_scoring_order_by_secondary\": null,\n                        \"ice_hockey_team_scoring_order_dir\": \"desc\",\n                        \"ice_hockey_team_scoring_order_dir_secondary\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_by\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_val\": null,\n                        \"ice_hockey_team_stats_order_by\": null,\n                        \"ice_hockey_team_stats_order_by_secondary\": null,\n                        \"ice_hockey_team_stats_order_dir\": null,\n                        \"ice_hockey_team_stats_order_dir_secondary\": null,\n                        \"ice_hockey_team_stats_stat_qualify_by\": null,\n                        \"ice_hockey_team_stats_stat_qualify_val\": null,\n                        \"intermission_length\": 1,\n                        \"major_adjustment_time\": 0,\n                        \"major_penalty_time\": 5,\n                        \"match_penalty_time\": 5,\n                        \"max_goal_differential\": 0,\n                        \"max_player_major_penalties\": 2,\n                        \"max_player_penalties\": 5,\n                        \"max_team_penalties\": 15,\n                        \"minor_adjustment_time\": 0,\n                        \"minor_penalty_time\": 2,\n                        \"misconduct_time\": 10,\n                        \"overtime_intervals\": 2,\n                        \"overtime_length\": \"5\",\n                        \"post_live_updates\": true,\n                        \"regulation_time_intervals\": null,\n                        \"shootout_enabled\": false,\n                        \"stop_run_time\": true,\n                        \"time_interval_name\": \"period\",\n                        \"time_intervals\": [\n                            \"20\",\n                            \"20\",\n                            \"20\"\n                        ],\n                        \"timeout_time\": 1,\n                        \"timeouts\": 1,\n                        \"track_goal_types\": true,\n                        \"track_player_sog\": true,\n                        \"warmup_length\": 5\n                    },\n                    \"season_id\": 267440,\n                    \"original_scorer_can_edit\": null,\n                    \"force_real_time_scoring\": false,\n                    \"stat_tool_id\": 1848623,\n                    \"stats_can_be_unlinked\": null,\n                    \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n                    \"can_edit_final\": \"league_owner\",\n                    \"traded_player_stats\": null,\n                    \"game_sheet_auto_summary_enabled\": true,\n                    \"visible_stats\": \"league_xor_division\"\n                },\n                \"subseasons\": [\n                    {\n                        \"id\": 291621,\n                        \"name\": \"Regular Season\",\n                        \"season_id\": 267440,\n                        \"position\": 1,\n                        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"updated_at\": \"2016-04-15T11:02:33-07:00\",\n                        \"snl_scoring_enabled\": true,\n                        \"statistic_grouping_id\": 417884,\n                        \"workers_completed\": null,\n                        \"standing_preference\": {\n                            \"id\": 110425,\n                            \"standing_tool_id\": 1848627,\n                            \"standing_type_id\": 5,\n                            \"standings_aggregation_level\": \"league\",\n                            \"qualifiers\": null,\n                            \"qualifier_limit\": null,\n                            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"winning_team_custom_points\": null,\n                            \"losing_team_custom_points\": null,\n                            \"tied_team_custom_points\": null,\n                            \"label_mapping\": {},\n                            \"extended_fields\": [\n                                \"win_count\",\n                                \"loss_count\",\n                                \"tie_count\",\n                                \"points\"\n                            ],\n                            \"order_rule\": 1,\n                            \"overtime_win_custom_points\": null,\n                            \"overtime_loss_custom_points\": null,\n                            \"overtime_wins_include_in_wins\": true,\n                            \"overtime_losses_include_in_losses\": true,\n                            \"legacy_custom_points\": false\n                        },\n                        \"live_scoring_stat_configuration\": {\n                            \"show_plus_minus\": null,\n                            \"fair_play_points\": false\n                        }\n                    }\n                ]\n            }\n        ],\n        \"subseason_team_instance_mapping\": [\n            {\n                \"subseason_id\": 291621,\n                \"team_instance_id\": 1876243\n            }\n        ],\n        \"league_name\": \"Eastern League\",\n        \"site_name\": \"Sport Ngin API Demo Site\",\n        \"sport_name\": \"Ice Hockey\"\n    },\n    \"thumbnails\": {},\n    \"subseason_ids\": [\n        291621\n    ]\n}","name":"","status":200}]},"settings":"","url":"/team_instances/:id","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/team_instances/1876243\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances/1876243\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances/1876243\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get"},"order":16,"parentDoc":null,"project":"5641217e0ee5370d00da636d","user":"56e71f9edee212320019e731","hidden":false,"version":"56cca51eca43550b002813fa","body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attributes\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"1-0\": \"name\",\n    \"1-1\": \"String\",\n    \"2-0\": \"buttom_title\",\n    \"2-1\": \"String\",\n    \"3-0\": \"abbrev\",\n    \"3-1\": \"String\",\n    \"4-0\": \"image_id\",\n    \"4-1\": \"Integer\",\n    \"5-0\": \"primary_color\",\n    \"5-1\": \"String\",\n    \"6-0\": \"secondary_color\",\n    \"6-1\": \"String\",\n    \"7-0\": \"thumbnails\",\n    \"7-1\": \"Array of Strings\",\n    \"7-2\": \"derived field. thumbnails of the team logo\",\n    \"8-0\": \"created_at\",\n    \"8-1\": \"Datetime\",\n    \"9-0\": \"Uploaded_at\",\n    \"9-1\": \"Datetime\",\n    \"10-0\": \"thumbnails\",\n    \"10-1\": \"Hash\",\n    \"10-2\": \"A hash of the thumbnail urls. Keys: small, medium, and large\",\n    \"0-2\": \"Unique id assigned by NGIN\",\n    \"1-2\": \"Name of the team\",\n    \"2-2\": \"Version of team name that displays on buttons and links\",\n    \"3-2\": \"Abbreviation of the team name\",\n    \"4-2\": \"ID of the team image\",\n    \"5-2\": \"Hex code of the team's primary color\",\n    \"6-2\": \"Hex code of the team's secondary color\",\n    \"8-2\": \"Timestamp of creation date\",\n    \"9-2\": \"Timestamp of last update\",\n    \"11-0\": \"roster_id\",\n    \"11-1\": \"Integer\",\n    \"11-2\": \"id of the roster assigned by NGIN\",\n    \"12-0\": \"team_id\",\n    \"12-1\": \"Integer\",\n    \"12-2\": \"id of the team assigned by NGIN\",\n    \"13-0\": \"affects_standings\",\n    \"13-1\": \"Boolean\",\n    \"13-2\": \"Determines if this teams games affect overall league/division standings\",\n    \"14-0\": \"team\",\n    \"14-1\": \"Hash\",\n    \"14-2\": \"team data\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]","createdAt":"2016-03-22T21:55:49.983Z","editedParams":true,"excerpt":"The Show method returns a single Team Instance for a given `id`.\n\n###Parameters","type":"get","__v":8,"category":"56e03709f97d422900d63922","githubsync":"","link_url":"","slug":"team-instances-show","updates":[],"editedParams2":true,"isReference":true,"link_external":false,"sync_unique":"","title":"Team Instances Show","childrenPages":[]}

getTeam Instances Show

The Show method returns a single Team Instance for a given `id`. ###Parameters

Path Params

id:

required

integer

Id belonging to the team_instance of interest

Attributes

Type

Notes

Integer

Unique id assigned by NGIN

name

String

Name of the team

buttom_title

String

Version of team name that displays on buttons and links

abbrev

String

Abbreviation of the team name

image_id

Integer

ID of the team image

primary_color

String

Hex code of the team's primary color

secondary_color

String

Hex code of the team's secondary color

thumbnails

Array of Strings

derived field. thumbnails of the team logo

created_at

Datetime

Timestamp of creation date

Uploaded_at

Datetime

Timestamp of last update

thumbnails

Hash

A hash of the thumbnail urls. Keys: small, medium, and large

roster_id

Integer

id of the roster assigned by NGIN

team_id

Integer

id of the team assigned by NGIN

affects_standings

Boolean

Determines if this teams games affect overall league/division standings

team

Hash

team data

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/team_instances/1876243"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances/1876243")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances/1876243")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1876243,
    "created_at": "2016-03-22T13:19:12-07:00",
    "updated_at": "2016-03-23T09:34:28-07:00",
    "team_id": 1373611,
    "affects_standings": true,
    "name": "Boston Bears",
    "roster_id": 1837158,
    "opponent": null,
    "parent_team_instance_id": null,
    "image_id": null,
    "abbrev": "Bos",
    "primary_color": "000000",
    "secondary_color": "000000",
    "button_title": "Boston",
    "gender": "male",
    "management_team_id": null,
    "team": {
        "id": 1373611,
        "name": "Boston Bears",
        "button_title": "Boston",
        "abbrev": "Bos",
        "image_id": null,
        "primary_color": "000000",
        "secondary_color": "000000",
        "gender": "male",
        "created_at": "2016-03-22T13:06:41-07:00",
        "updated_at": "2016-03-23T09:34:28-07:00",
        "sport_id": 1,
        "opponent": null,
        "parent_team_id": null,
        "ios_whitelabel_url": null,
        "android_whitelabel_url": null,
        "sites": [
            {
                "id": 11953,
                "domain_id": 1149,
                "domain_name": "sportngin.com",
                "subdomain": "apidemo",
                "product_id": 14,
                "name": "Sport Ngin API Demo Site",
                "short_name": "Sport Ngin API Demo Site",
                "created_on": "2016-02-24T06:32:26-08:00",
                "updated_on": "2016-04-08T10:04:54-07:00",
                "created_by_user_id": 3156422,
                "updated_by_user_id": null,
                "timezone": "US/Central",
                "twitter_user_id": null,
                "layout_theme_id": 51,
                "secure_subdomain": "apidemo",
                "address_id": 4447713,
                "membership_privacy": "open",
                "membership_grace_period": 1,
                "boss_billing_account_id": null,
                "boss_organization_id": 27743
            }
        ],
        "leagues": [
            {
                "id": 27737,
                "name": "Eastern League",
                "current_subseason_id": 291621,
                "site_id": 11953,
                "sport_id": 1,
                "image_id": null,
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-24T07:20:49-07:00",
                "button_title": "Eastern",
                "primary_color": "00AEEF",
                "secondary_color": "666666",
                "gender": "male",
                "abbrev": "East",
                "score_ribbon": false,
                "tweet_games": null,
                "game_sheet_label": "gamesheet"
            }
        ],
        "thumbnails": {},
        "thumbnails_ssl": {},
        "current_subseason_ids": [
            291621
        ],
        "seasons": [
            {
                "id": 267440,
                "name": "2016",
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-22T12:46:58-07:00",
                "solo_team_league_id": null,
                "has_metadata": null,
                "show_shared_schedule": false,
                "stat_preference": {
                    "id": 292407,
                    "updated_on": "2016-03-22T12:46:58-07:00",
                    "created_on": "2016-03-22T12:46:58-07:00",
                    "game_defaults": {
                        "auto_navigate_to_play_details": true,
                        "field_of_play_enabled": false,
                        "game_misconduct_time": 0,
                        "ice_hockey_goalie_order_by": null,
                        "ice_hockey_goalie_order_by_secondary": null,
                        "ice_hockey_goalie_order_dir": null,
                        "ice_hockey_goalie_order_dir_secondary": null,
                        "ice_hockey_goalie_stat_qualify_by": null,
                        "ice_hockey_goalie_stat_qualify_val": null,
                        "ice_hockey_skater_order_by": null,
                        "ice_hockey_skater_order_by_secondary": null,
                        "ice_hockey_skater_order_dir": null,
                        "ice_hockey_skater_order_dir_secondary": null,
                        "ice_hockey_skater_stat_qualify_by": null,
                        "ice_hockey_skater_stat_qualify_val": null,
                        "ice_hockey_team_scoring_order_by": "pts",
                        "ice_hockey_team_scoring_order_by_secondary": null,
                        "ice_hockey_team_scoring_order_dir": "desc",
                        "ice_hockey_team_scoring_order_dir_secondary": null,
                        "ice_hockey_team_scoring_stat_qualify_by": null,
                        "ice_hockey_team_scoring_stat_qualify_val": null,
                        "ice_hockey_team_stats_order_by": null,
                        "ice_hockey_team_stats_order_by_secondary": null,
                        "ice_hockey_team_stats_order_dir": null,
                        "ice_hockey_team_stats_order_dir_secondary": null,
                        "ice_hockey_team_stats_stat_qualify_by": null,
                        "ice_hockey_team_stats_stat_qualify_val": null,
                        "intermission_length": 1,
                        "major_adjustment_time": 0,
                        "major_penalty_time": 5,
                        "match_penalty_time": 5,
                        "max_goal_differential": 0,
                        "max_player_major_penalties": 2,
                        "max_player_penalties": 5,
                        "max_team_penalties": 15,
                        "minor_adjustment_time": 0,
                        "minor_penalty_time": 2,
                        "misconduct_time": 10,
                        "overtime_intervals": 2,
                        "overtime_length": "5",
                        "post_live_updates": true,
                        "regulation_time_intervals": null,
                        "shootout_enabled": false,
                        "stop_run_time": true,
                        "time_interval_name": "period",
                        "time_intervals": [
                            "20",
                            "20",
                            "20"
                        ],
                        "timeout_time": 1,
                        "timeouts": 1,
                        "track_goal_types": true,
                        "track_player_sog": true,
                        "warmup_length": 5
                    },
                    "season_id": 267440,
                    "original_scorer_can_edit": null,
                    "force_real_time_scoring": false,
                    "stat_tool_id": 1848623,
                    "stats_can_be_unlinked": null,
                    "scoring_methods": "--- \n- live\n- mass\n- tabular\n- quick\n",
                    "can_edit_final": "league_owner",
                    "traded_player_stats": null,
                    "game_sheet_auto_summary_enabled": true,
                    "visible_stats": "league_xor_division"
                },
                "subseasons": [
                    {
                        "id": 291621,
                        "name": "Regular Season",
                        "season_id": 267440,
                        "position": 1,
                        "created_at": "2016-03-22T12:46:58-07:00",
                        "updated_at": "2016-04-15T11:02:33-07:00",
                        "snl_scoring_enabled": true,
                        "statistic_grouping_id": 417884,
                        "workers_completed": null,
                        "standing_preference": {
                            "id": 110425,
                            "standing_tool_id": 1848627,
                            "standing_type_id": 5,
                            "standings_aggregation_level": "league",
                            "qualifiers": null,
                            "qualifier_limit": null,
                            "created_at": "2016-03-22T12:46:58-07:00",
                            "updated_at": "2016-03-22T12:46:58-07:00",
                            "winning_team_custom_points": null,
                            "losing_team_custom_points": null,
                            "tied_team_custom_points": null,
                            "label_mapping": {},
                            "extended_fields": [
                                "win_count",
                                "loss_count",
                                "tie_count",
                                "points"
                            ],
                            "order_rule": 1,
                            "overtime_win_custom_points": null,
                            "overtime_loss_custom_points": null,
                            "overtime_wins_include_in_wins": true,
                            "overtime_losses_include_in_losses": true,
                            "legacy_custom_points": false
                        },
                        "live_scoring_stat_configuration": {
                            "show_plus_minus": null,
                            "fair_play_points": false
                        }
                    }
                ]
            }
        ],
        "subseason_team_instance_mapping": [
            {
                "subseason_id": 291621,
                "team_instance_id": 1876243
            }
        ],
        "league_name": "Eastern League",
        "site_name": "Sport Ngin API Demo Site",
        "sport_name": "Ice Hockey"
    },
    "thumbnails": {},
    "subseason_ids": [
        291621
    ]
}

{"_id":"56e0470f4685db1700d947ca","link_external":false,"title":"Team Instances Create","githubsync":"","hidden":false,"isReference":true,"slug":"team-instances-create","version":"56cca51eca43550b002813fa","__v":10,"api":{"examples":{"codes":[{"name":"cURL - New Team","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"top_new_team_template_id\": 23220,\n    \"bottom_new_team_template_id\": 23221,\n    \"team\":\n        {\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\"\n        }\n}\n    ' \"https://api.sportngin.com/team_instances?subseason_id=291621\"","language":"curl"},{"name":"Ruby - New Team","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances?subseason_id=291621\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"existing_or_new\\\": \\\"new\\\",\\n    \\\"team\\\":\\n        {\\n        \\\"name\\\": \\\"API TEST TEAM\\\",\\n        \\\"button_title\\\": \\\"API TEAM\\\",\\n        \\\"abbrev\\\": \\\"ATT\\\",\\n        \\\"primary_color\\\": \\\"FFFFFF\\\",\\n        \\\"secondary_color\\\": \\\"AAAAAA\\\"\\n        }\\n}\\n    \"\n\nresponse = http.request(request)\nputs response.read_body","language":"ruby"},{"name":"Java - New Team","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"existing_or_new\\\": \\\"new\\\",\\n    \\\"team\\\":\\n        {\\n        \\\"name\\\": \\\"API TEST TEAM\\\",\\n        \\\"button_title\\\": \\\"API TEAM\\\",\\n        \\\"abbrev\\\": \\\"ATT\\\",\\n        \\\"primary_color\\\": \\\"FFFFFF\\\",\\n        \\\"secondary_color\\\": \\\"AAAAAA\\\"\\n        }\\n}\\n    \");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances?subseason_id=291621\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"},{"name":"cURL - Existing Team","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n    {\n    \"parent_node_id\": 2458074,\n    \"top_existing_team_template_id\": 23220,\n    \"bottom_existing_team_template_id\": 23220,\n    \"node\":\n    {\n    \"team_id\": 1373611\n    }\n}\n    ' \"https://api.sportngin.com/team_instances?subseason_id=291621\"","language":"curl"},{"code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances?subseason_id=291621\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"top_existing_team_template_id\\\": 23220,\\n    \\\"bottom_existing_team_template_id\\\": 23221,\\n    \\\"node\\\":\\n        {\\n        \\\"team_id\\\": 1373611,\\n}\\n}\\n    \"\n\nresponse = http.request(request)\nputs response.read_body","language":"ruby","name":"Ruby - Existing Team"},{"name":"Java - Existing Team","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"top_existing_team_template_id\\\": 23220,\\n    \\\"bottom_existing_team_template_id\\\": 23221,\\n    \\\"node\\\":\\n        {\\n        \\\"team_id\\\": 1373611,\\n}\\n}\\n    \");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances?subseason_id=291621\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"}]},"method":"post","params":[{"in":"path","required":true,"desc":"","default":"","type":"int","name":"subseason_id","_id":"57eeac5ecc36920e00bff4b9","ref":""},{"desc":"","default":"","type":"int","name":"league_instance_id","_id":"57eeac5ecc36920e00bff4b8","ref":"","in":"path","required":true},{"_id":"58867c1d9321a50f00f3eb13","default":"","desc":"ID of the node beneath which the team will be placed","in":"body","name":"parent_node_id","ref":"","required":true,"type":"int"},{"name":"existing_or_new","_id":"58867c1d9321a50f00f3eb12","ref":"","in":"body","required":true,"desc":"Denotes whether the new Team Instance will be created under a new or existing Team","default":"existing","type":"string"},{"type":"int","name":"top_new_team_template_id","_id":"58867c1d9321a50f00f3eb11","ref":"","in":"body","required":false,"desc":"Top template for team page if new team","default":""},{"desc":"Top template for team page if existing team","default":"","type":"int","name":"top_existing_team_template_id","_id":"58867c1d9321a50f00f3eb10","ref":"","in":"body","required":false},{"_id":"58867c1d9321a50f00f3eb0f","ref":"","in":"body","required":false,"desc":"Bottom template for team page if new team","default":"","type":"int","name":"bottom_new_team_template_id"},{"_id":"58867c1d9321a50f00f3eb0e","ref":"","in":"body","required":false,"desc":"Bottom template for team page if existing team","default":"","type":"int","name":"bottom_existing_team_template_id"},{"_id":"58867c1d9321a50f00f3eb0d","ref":"","in":"body","required":false,"desc":"ID of Team of which to create new instance of","default":"","type":"int","name":"node[team_id]"},{"_id":"58867c1d9321a50f00f3eb0c","ref":"","in":"body","required":false,"desc":"Name of team if team does not already exist","default":"","type":"string","name":"team[name]"},{"_id":"58867c1d9321a50f00f3eb0b","ref":"","in":"body","required":false,"desc":"Button title of team if team does not already exist","default":"","type":"string","name":"team[button_title]"},{"name":"team[abbrev]","_id":"58867c1d9321a50f00f3eb0a","ref":"","in":"body","required":false,"desc":"Abbreviation of team name if team does not already exist","default":"","type":"string"},{"ref":"","in":"body","required":false,"desc":"Team primary color if team does not already exist","default":"","type":"string","name":"team[primary_color]","_id":"58867c1d9321a50f00f3eb09"},{"default":"","type":"string","name":"team[secondary_color]","_id":"58867c1d9321a50f00f3eb08","ref":"","in":"body","required":false,"desc":"Team secondary color if team does not already exist"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"id\": 1930618,\n    \"created_at\": \"2016-04-22T09:00:25-07:00\",\n    \"updated_at\": \"2016-04-22T09:00:25-07:00\",\n    \"team_id\": 1413546,\n    \"affects_standings\": true,\n    \"name\": \"API TEST TEAM\",\n    \"roster_id\": 1892176,\n    \"opponent\": null,\n    \"parent_team_instance_id\": null,\n    \"image_id\": null,\n    \"abbrev\": \"ATT\",\n    \"primary_color\": \"FFFFFF\",\n    \"secondary_color\": \"AAAAAA\",\n    \"button_title\": \"API TEAM\",\n    \"gender\": \"male\",\n    \"management_team_id\": null,\n    \"team\": {\n        \"id\": 1413546,\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"image_id\": null,\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\",\n        \"gender\": null,\n        \"created_at\": \"2016-04-22T09:00:25-07:00\",\n        \"updated_at\": \"2016-04-22T09:00:25-07:00\",\n        \"sport_id\": 1,\n        \"opponent\": null,\n        \"parent_team_id\": null,\n        \"ios_whitelabel_url\": null,\n        \"android_whitelabel_url\": null,\n        \"sites\": [\n            {\n                \"id\": 11953,\n                \"domain_id\": 1149,\n                \"domain_name\": \"sportngin.com\",\n                \"subdomain\": \"apidemo\",\n                \"product_id\": 14,\n                \"name\": \"Sport Ngin API Demo Site\",\n                \"short_name\": \"Sport Ngin API Demo Site\",\n                \"created_on\": \"2016-02-24T06:32:26-08:00\",\n                \"updated_on\": \"2016-04-08T10:04:54-07:00\",\n                \"created_by_user_id\": 3156422,\n                \"updated_by_user_id\": null,\n                \"timezone\": \"US/Central\",\n                \"twitter_user_id\": null,\n                \"layout_theme_id\": 51,\n                \"secure_subdomain\": \"apidemo\",\n                \"address_id\": 4447713,\n                \"membership_privacy\": \"open\",\n                \"membership_grace_period\": 1,\n                \"boss_billing_account_id\": null,\n                \"boss_organization_id\": 27743\n            }\n        ],\n        \"leagues\": [\n            {\n                \"id\": 27737,\n                \"name\": \"Eastern League\",\n                \"current_subseason_id\": 291621,\n                \"site_id\": 11953,\n                \"sport_id\": 1,\n                \"image_id\": null,\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n                \"button_title\": \"Eastern\",\n                \"primary_color\": \"00AEEF\",\n                \"secondary_color\": \"666666\",\n                \"gender\": \"male\",\n                \"abbrev\": \"East\",\n                \"score_ribbon\": false,\n                \"tweet_games\": null,\n                \"game_sheet_label\": \"gamesheet\"\n            }\n        ],\n        \"thumbnails\": {},\n        \"thumbnails_ssl\": {},\n        \"current_subseason_ids\": [\n            291621\n        ],\n        \"seasons\": [\n            {\n                \"id\": 267440,\n                \"name\": \"2016\",\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                \"solo_team_league_id\": null,\n                \"has_metadata\": null,\n                \"show_shared_schedule\": false,\n                \"stat_preference\": {\n                    \"id\": 292407,\n                    \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"created_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"game_defaults\": {\n                        \"auto_navigate_to_play_details\": true,\n                        \"field_of_play_enabled\": false,\n                        \"game_misconduct_time\": 0,\n                        \"ice_hockey_goalie_order_by\": null,\n                        \"ice_hockey_goalie_order_by_secondary\": null,\n                        \"ice_hockey_goalie_order_dir\": null,\n                        \"ice_hockey_goalie_order_dir_secondary\": null,\n                        \"ice_hockey_goalie_stat_qualify_by\": null,\n                        \"ice_hockey_goalie_stat_qualify_val\": null,\n                        \"ice_hockey_skater_order_by\": null,\n                        \"ice_hockey_skater_order_by_secondary\": null,\n                        \"ice_hockey_skater_order_dir\": null,\n                        \"ice_hockey_skater_order_dir_secondary\": null,\n                        \"ice_hockey_skater_stat_qualify_by\": null,\n                        \"ice_hockey_skater_stat_qualify_val\": null,\n                        \"ice_hockey_team_scoring_order_by\": \"pts\",\n                        \"ice_hockey_team_scoring_order_by_secondary\": null,\n                        \"ice_hockey_team_scoring_order_dir\": \"desc\",\n                        \"ice_hockey_team_scoring_order_dir_secondary\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_by\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_val\": null,\n                        \"ice_hockey_team_stats_order_by\": null,\n                        \"ice_hockey_team_stats_order_by_secondary\": null,\n                        \"ice_hockey_team_stats_order_dir\": null,\n                        \"ice_hockey_team_stats_order_dir_secondary\": null,\n                        \"ice_hockey_team_stats_stat_qualify_by\": null,\n                        \"ice_hockey_team_stats_stat_qualify_val\": null,\n                        \"intermission_length\": 1,\n                        \"major_adjustment_time\": 0,\n                        \"major_penalty_time\": 5,\n                        \"match_penalty_time\": 5,\n                        \"max_goal_differential\": 0,\n                        \"max_player_major_penalties\": 2,\n                        \"max_player_penalties\": 5,\n                        \"max_team_penalties\": 15,\n                        \"minor_adjustment_time\": 0,\n                        \"minor_penalty_time\": 2,\n                        \"misconduct_time\": 10,\n                        \"overtime_intervals\": 2,\n                        \"overtime_length\": \"5\",\n                        \"post_live_updates\": true,\n                        \"regulation_time_intervals\": null,\n                        \"shootout_enabled\": false,\n                        \"stop_run_time\": true,\n                        \"time_interval_name\": \"period\",\n                        \"time_intervals\": [\n                            \"20\",\n                            \"20\",\n                            \"20\"\n                        ],\n                        \"timeout_time\": 1,\n                        \"timeouts\": 1,\n                        \"track_goal_types\": true,\n                        \"track_player_sog\": true,\n                        \"warmup_length\": 5\n                    },\n                    \"season_id\": 267440,\n                    \"original_scorer_can_edit\": null,\n                    \"force_real_time_scoring\": false,\n                    \"stat_tool_id\": 1848623,\n                    \"stats_can_be_unlinked\": null,\n                    \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n                    \"can_edit_final\": \"league_owner\",\n                    \"traded_player_stats\": null,\n                    \"game_sheet_auto_summary_enabled\": true,\n                    \"visible_stats\": \"league_xor_division\"\n                },\n                \"subseasons\": [\n                    {\n                        \"id\": 291621,\n                        \"name\": \"Regular Season\",\n                        \"season_id\": 267440,\n                        \"position\": 1,\n                        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"updated_at\": \"2016-04-20T11:53:00-07:00\",\n                        \"snl_scoring_enabled\": true,\n                        \"statistic_grouping_id\": 417884,\n                        \"workers_completed\": null,\n                        \"standing_preference\": {\n                            \"id\": 110425,\n                            \"standing_tool_id\": 1848627,\n                            \"standing_type_id\": 5,\n                            \"standings_aggregation_level\": \"league\",\n                            \"qualifiers\": null,\n                            \"qualifier_limit\": null,\n                            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"winning_team_custom_points\": null,\n                            \"losing_team_custom_points\": null,\n                            \"tied_team_custom_points\": null,\n                            \"label_mapping\": {},\n                            \"extended_fields\": [\n                                \"win_count\",\n                                \"loss_count\",\n                                \"tie_count\",\n                                \"points\"\n                            ],\n                            \"order_rule\": 1,\n                            \"overtime_win_custom_points\": null,\n                            \"overtime_loss_custom_points\": null,\n                            \"overtime_wins_include_in_wins\": true,\n                            \"overtime_losses_include_in_losses\": true,\n                            \"legacy_custom_points\": false\n                        },\n                        \"live_scoring_stat_configuration\": {\n                            \"show_plus_minus\": null,\n                            \"fair_play_points\": false\n                        }\n                    }\n                ]\n            }\n        ],\n        \"subseason_team_instance_mapping\": [\n            {\n                \"subseason_id\": 291621,\n                \"team_instance_id\": 1930618\n            }\n        ],\n        \"league_name\": \"Eastern League\",\n        \"site_name\": \"Sport Ngin API Demo Site\",\n        \"sport_name\": \"Ice Hockey\"\n    },\n    \"thumbnails\": {},\n    \"subseason_ids\": [\n        291621\n    ]\n}"}]},"settings":"","url":"/team_instances","auth":"required"},"category":"56e03709f97d422900d63922","order":17,"link_url":"","parentDoc":null,"type":"post","updates":[],"body":"","createdAt":"2016-03-09T15:53:51.431Z","editedParams":true,"excerpt":"The Create method accepts a single Team Instance (see attributes above) and creates a new record in SportsEngine.  This endpoint requires at least one parameter: either `subseason_id` or `league_instance_id`.\n\n###Parameters","user":"56548c568975c70d002ea4b4","editedParams2":true,"next":{"description":"","pages":[]},"project":"5641217e0ee5370d00da636d","sync_unique":"","childrenPages":[]}

postTeam Instances Create

The Create method accepts a single Team Instance (see attributes above) and creates a new record in SportsEngine. This endpoint requires at least one parameter: either `subseason_id` or `league_instance_id`. ###Parameters

Path Params

subseason_id:

required

integer

league_instance_id:

required

integer

Body Params

parent_node_id:

required

integer

ID of the node beneath which the team will be placed

existing_or_new:

required

stringexisting

Denotes whether the new Team Instance will be created under a new or existing Team

top_new_team_template_id:

integer

Top template for team page if new team

top_existing_team_template_id:

integer

Top template for team page if existing team

bottom_new_team_template_id:

integer

Bottom template for team page if new team

bottom_existing_team_template_id:

integer

Bottom template for team page if existing team

node[team_id]:

integer

ID of Team of which to create new instance of

team[name]:

string

Name of team if team does not already exist

team[button_title]:

string

Button title of team if team does not already exist

team[abbrev]:

string

Abbreviation of team name if team does not already exist

team[primary_color]:

string

Team primary color if team does not already exist

team[secondary_color]:

string

Team secondary color if team does not already exist

Definition

Examples

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
    "parent_node_id": 2458074,
    "existing_or_new": "new",
    "top_new_team_template_id": 23220,
    "bottom_new_team_template_id": 23221,
    "team":
        {
        "name": "API TEST TEAM",
        "button_title": "API TEAM",
        "abbrev": "ATT",
        "primary_color": "FFFFFF",
        "secondary_color": "AAAAAA"
        }
}
    ' "https://api.sportngin.com/team_instances?subseason_id=291621"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances?subseason_id=291621")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"team\":\n        {\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\"\n        }\n}\n    "

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"team\":\n        {\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\"\n        }\n}\n    ");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances?subseason_id=291621")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
    {
    "parent_node_id": 2458074,
    "top_existing_team_template_id": 23220,
    "bottom_existing_team_template_id": 23220,
    "node":
    {
    "team_id": 1373611
    }
}
    ' "https://api.sportngin.com/team_instances?subseason_id=291621"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances?subseason_id=291621")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"parent_node_id\": 2458074,\n    \"top_existing_team_template_id\": 23220,\n    \"bottom_existing_team_template_id\": 23221,\n    \"node\":\n        {\n        \"team_id\": 1373611,\n}\n}\n    "

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"parent_node_id\": 2458074,\n    \"top_existing_team_template_id\": 23220,\n    \"bottom_existing_team_template_id\": 23221,\n    \"node\":\n        {\n        \"team_id\": 1373611,\n}\n}\n    ");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances?subseason_id=291621")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1930618,
    "created_at": "2016-04-22T09:00:25-07:00",
    "updated_at": "2016-04-22T09:00:25-07:00",
    "team_id": 1413546,
    "affects_standings": true,
    "name": "API TEST TEAM",
    "roster_id": 1892176,
    "opponent": null,
    "parent_team_instance_id": null,
    "image_id": null,
    "abbrev": "ATT",
    "primary_color": "FFFFFF",
    "secondary_color": "AAAAAA",
    "button_title": "API TEAM",
    "gender": "male",
    "management_team_id": null,
    "team": {
        "id": 1413546,
        "name": "API TEST TEAM",
        "button_title": "API TEAM",
        "abbrev": "ATT",
        "image_id": null,
        "primary_color": "FFFFFF",
        "secondary_color": "AAAAAA",
        "gender": null,
        "created_at": "2016-04-22T09:00:25-07:00",
        "updated_at": "2016-04-22T09:00:25-07:00",
        "sport_id": 1,
        "opponent": null,
        "parent_team_id": null,
        "ios_whitelabel_url": null,
        "android_whitelabel_url": null,
        "sites": [
            {
                "id": 11953,
                "domain_id": 1149,
                "domain_name": "sportngin.com",
                "subdomain": "apidemo",
                "product_id": 14,
                "name": "Sport Ngin API Demo Site",
                "short_name": "Sport Ngin API Demo Site",
                "created_on": "2016-02-24T06:32:26-08:00",
                "updated_on": "2016-04-08T10:04:54-07:00",
                "created_by_user_id": 3156422,
                "updated_by_user_id": null,
                "timezone": "US/Central",
                "twitter_user_id": null,
                "layout_theme_id": 51,
                "secure_subdomain": "apidemo",
                "address_id": 4447713,
                "membership_privacy": "open",
                "membership_grace_period": 1,
                "boss_billing_account_id": null,
                "boss_organization_id": 27743
            }
        ],
        "leagues": [
            {
                "id": 27737,
                "name": "Eastern League",
                "current_subseason_id": 291621,
                "site_id": 11953,
                "sport_id": 1,
                "image_id": null,
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-24T07:20:49-07:00",
                "button_title": "Eastern",
                "primary_color": "00AEEF",
                "secondary_color": "666666",
                "gender": "male",
                "abbrev": "East",
                "score_ribbon": false,
                "tweet_games": null,
                "game_sheet_label": "gamesheet"
            }
        ],
        "thumbnails": {},
        "thumbnails_ssl": {},
        "current_subseason_ids": [
            291621
        ],
        "seasons": [
            {
                "id": 267440,
                "name": "2016",
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-22T12:46:58-07:00",
                "solo_team_league_id": null,
                "has_metadata": null,
                "show_shared_schedule": false,
                "stat_preference": {
                    "id": 292407,
                    "updated_on": "2016-03-22T12:46:58-07:00",
                    "created_on": "2016-03-22T12:46:58-07:00",
                    "game_defaults": {
                        "auto_navigate_to_play_details": true,
                        "field_of_play_enabled": false,
                        "game_misconduct_time": 0,
                        "ice_hockey_goalie_order_by": null,
                        "ice_hockey_goalie_order_by_secondary": null,
                        "ice_hockey_goalie_order_dir": null,
                        "ice_hockey_goalie_order_dir_secondary": null,
                        "ice_hockey_goalie_stat_qualify_by": null,
                        "ice_hockey_goalie_stat_qualify_val": null,
                        "ice_hockey_skater_order_by": null,
                        "ice_hockey_skater_order_by_secondary": null,
                        "ice_hockey_skater_order_dir": null,
                        "ice_hockey_skater_order_dir_secondary": null,
                        "ice_hockey_skater_stat_qualify_by": null,
                        "ice_hockey_skater_stat_qualify_val": null,
                        "ice_hockey_team_scoring_order_by": "pts",
                        "ice_hockey_team_scoring_order_by_secondary": null,
                        "ice_hockey_team_scoring_order_dir": "desc",
                        "ice_hockey_team_scoring_order_dir_secondary": null,
                        "ice_hockey_team_scoring_stat_qualify_by": null,
                        "ice_hockey_team_scoring_stat_qualify_val": null,
                        "ice_hockey_team_stats_order_by": null,
                        "ice_hockey_team_stats_order_by_secondary": null,
                        "ice_hockey_team_stats_order_dir": null,
                        "ice_hockey_team_stats_order_dir_secondary": null,
                        "ice_hockey_team_stats_stat_qualify_by": null,
                        "ice_hockey_team_stats_stat_qualify_val": null,
                        "intermission_length": 1,
                        "major_adjustment_time": 0,
                        "major_penalty_time": 5,
                        "match_penalty_time": 5,
                        "max_goal_differential": 0,
                        "max_player_major_penalties": 2,
                        "max_player_penalties": 5,
                        "max_team_penalties": 15,
                        "minor_adjustment_time": 0,
                        "minor_penalty_time": 2,
                        "misconduct_time": 10,
                        "overtime_intervals": 2,
                        "overtime_length": "5",
                        "post_live_updates": true,
                        "regulation_time_intervals": null,
                        "shootout_enabled": false,
                        "stop_run_time": true,
                        "time_interval_name": "period",
                        "time_intervals": [
                            "20",
                            "20",
                            "20"
                        ],
                        "timeout_time": 1,
                        "timeouts": 1,
                        "track_goal_types": true,
                        "track_player_sog": true,
                        "warmup_length": 5
                    },
                    "season_id": 267440,
                    "original_scorer_can_edit": null,
                    "force_real_time_scoring": false,
                    "stat_tool_id": 1848623,
                    "stats_can_be_unlinked": null,
                    "scoring_methods": "--- \n- live\n- mass\n- tabular\n- quick\n",
                    "can_edit_final": "league_owner",
                    "traded_player_stats": null,
                    "game_sheet_auto_summary_enabled": true,
                    "visible_stats": "league_xor_division"
                },
                "subseasons": [
                    {
                        "id": 291621,
                        "name": "Regular Season",
                        "season_id": 267440,
                        "position": 1,
                        "created_at": "2016-03-22T12:46:58-07:00",
                        "updated_at": "2016-04-20T11:53:00-07:00",
                        "snl_scoring_enabled": true,
                        "statistic_grouping_id": 417884,
                        "workers_completed": null,
                        "standing_preference": {
                            "id": 110425,
                            "standing_tool_id": 1848627,
                            "standing_type_id": 5,
                            "standings_aggregation_level": "league",
                            "qualifiers": null,
                            "qualifier_limit": null,
                            "created_at": "2016-03-22T12:46:58-07:00",
                            "updated_at": "2016-03-22T12:46:58-07:00",
                            "winning_team_custom_points": null,
                            "losing_team_custom_points": null,
                            "tied_team_custom_points": null,
                            "label_mapping": {},
                            "extended_fields": [
                                "win_count",
                                "loss_count",
                                "tie_count",
                                "points"
                            ],
                            "order_rule": 1,
                            "overtime_win_custom_points": null,
                            "overtime_loss_custom_points": null,
                            "overtime_wins_include_in_wins": true,
                            "overtime_losses_include_in_losses": true,
                            "legacy_custom_points": false
                        },
                        "live_scoring_stat_configuration": {
                            "show_plus_minus": null,
                            "fair_play_points": false
                        }
                    }
                ]
            }
        ],
        "subseason_team_instance_mapping": [
            {
                "subseason_id": 291621,
                "team_instance_id": 1930618
            }
        ],
        "league_name": "Eastern League",
        "site_name": "Sport Ngin API Demo Site",
        "sport_name": "Ice Hockey"
    },
    "thumbnails": {},
    "subseason_ids": [
        291621
    ]
}

{"_id":"58866fd62822ed0f00d5b4d3","isReference":true,"version":"56cca51eca43550b002813fa","__v":5,"category":"56e03709f97d422900d63922","createdAt":"2017-01-23T21:04:22.702Z","slug":"team-instances-create-no-league","sync_unique":"","title":"Team Instances Create (no league)","updates":[],"body":"","hidden":false,"next":{"description":"","pages":[]},"order":18,"user":"56548c568975c70d002ea4b4","parentDoc":null,"api":{"settings":"","url":"/team_instances","auth":"required","examples":{"codes":[{"name":"cURL - New Team","language":"curl","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"top_new_team_template_id\": 23220,\n    \"bottom_new_team_template_id\": 23221,\n    \"season\":\n    \t\t{\n    \t\t\"name\": \"2017-18\"\n    \t\t},\n    \"subseason\":\n    \t\t{\n    \t\t\"name\": \"Regular Season\"\n    \t\t},\n    \"league\":\n    \t\t{\n    \t\t\"sport_id\": 1\n    \t\t},\n    \"team\":\n        {\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\"\n        }\n}\n    ' \"https://api.sportngin.com/team_instances\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"existing_or_new\\\": \\\"new\\\",\\n    \\\"top_new_team_template_id\\\": 23220,\\n    \\\"bottom_new_team_template_id\\\": 23220,\\n    \\\"season\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"2017-18\\\"\\n    \\t},\\n    \\\"subseason\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"Regular Season\\\"\\n    \\t},\\n    \\\"league\\\":\\n    \\t{\\n    \\t\\\"sport_id\\\": 1\\n    \\t},\\n    \\\"team\\\":\\n        {\\n        \\\"name\\\": \\\"API TEST TEAM\\\",\\n        \\\"button_title\\\": \\\"API TEAM\\\",\\n        \\\"abbrev\\\": \\\"ATT\\\",\\n        \\\"primary_color\\\": \\\"FFFFFF\\\",\\n        \\\"secondary_color\\\": \\\"AAAAAA\\\"\\n        }\\n}\"\n\nresponse = http.request(request)\nputs response.read_body","name":"Ruby - New Team"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"existing_or_new\\\": \\\"new\\\",\\n    \\\"top_new_team_template_id\\\": 23220,\\n    \\\"bottom_new_team_template_id\\\": 23220,\\n    \\\"season\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"2017-18\\\"\\n    \\t},\\n    \\\"subseason\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"Regular Season\\\"\\n    \\t},\\n    \\\"league\\\":\\n    \\t{\\n    \\t\\\"sport_id\\\": 1\\n    \\t},\\n    \\\"team\\\":\\n        {\\n        \\\"name\\\": \\\"API TEST TEAM\\\",\\n        \\\"button_title\\\": \\\"API TEAM\\\",\\n        \\\"abbrev\\\": \\\"ATT\\\",\\n        \\\"primary_color\\\": \\\"FFFFFF\\\",\\n        \\\"secondary_color\\\": \\\"AAAAAA\\\"\\n        }\\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","name":"Java - New Team"},{"language":"curl","code":"curl -X POST -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n    \"parent_node_id\": 2458074,\n    \"top_new_team_template_id\": 23220,\n    \"bottom_new_team_template_id\": 23221,\n    \"season\":\n    \t\t{\n    \t\t\"name\": \"2017-18\"\n    \t\t},\n    \"subseason\":\n    \t\t{\n    \t\t\"name\": \"Regular Season\"\n    \t\t},\n    \"league\":\n    \t\t{\n    \t\t\"sport_id\": 1\n    \t\t},\n  \t \"node\":\n    \t\t{\n   \t\t\t\"team_id\": 1373611\n    \t\t}\n}\n    ' \"https://api.sportngin.com/team_instances\"","name":"cURL - Existing Team"},{"code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"existing_or_new\\\": \\\"new\\\",\\n    \\\"top_new_team_template_id\\\": 23220,\\n    \\\"bottom_new_team_template_id\\\": 23220,\\n    \\\"season\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"2017-18\\\"\\n    \\t},\\n    \\\"subseason\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"Regular Season\\\"\\n    \\t},\\n    \\\"league\\\":\\n    \\t{\\n    \\t\\\"sport_id\\\": 1\\n    \\t},\\n    \\\"node\\\":\\n        {\\n        \\\"team_id\\\": 1373611\\n        }\\n}\"\n\nresponse = http.request(request)\nputs response.read_body","name":"Ruby - Existing Team","language":"ruby"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"parent_node_id\\\": 2458074,\\n    \\\"existing_or_new\\\": \\\"new\\\",\\n    \\\"top_new_team_template_id\\\": 23220,\\n    \\\"bottom_new_team_template_id\\\": 23220,\\n    \\\"season\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"2017-18\\\"\\n    \\t},\\n    \\\"subseason\\\":\\n    \\t{\\n    \\t\\\"name\\\": \\\"Regular Season\\\"\\n    \\t},\\n    \\\"league\\\":\\n    \\t{\\n    \\t\\\"sport_id\\\": 1\\n    \\t},\\n    \\\"node\\\":\\n        {\\n        \\\"team_id\\\": 1373611\\n        }\\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();","name":"Java - Existing Team"}]},"method":"post","params":[{"default":"","type":"int","name":"parent_node_id","_id":"5886737b9321a50f00f3eada","ref":"","in":"body","required":true,"desc":"ID of the node beneath which the team will be placed"},{"default":"existing","type":"string","name":"existing_or_new","_id":"5886737b9321a50f00f3ead9","ref":"","in":"body","required":true,"desc":"Denotes whether the new Team Instance will be created under a new or existing Team"},{"default":"","type":"int","name":"top_new_team_template_id","_id":"588675689a74d20f00f84b75","ref":"","in":"body","required":false,"desc":"Top template for team page if new team"},{"in":"body","required":false,"desc":"Top template for team page if existing team","default":"","type":"int","name":"top_existing_team_template_id","_id":"588675689a74d20f00f84b74","ref":""},{"required":false,"desc":"Bottom template for team page if new team","default":"","type":"int","name":"bottom_new_team_template_id","_id":"588675689a74d20f00f84b73","ref":"","in":"body"},{"type":"int","name":"bottom_existing_team_template_id","_id":"588675689a74d20f00f84b72","ref":"","in":"body","required":false,"desc":"Bottom template for team page if existing team","default":""},{"desc":"Sport ID for the team being created","default":"","type":"int","name":"league[sport_id]","_id":"5886737b9321a50f00f3ead1","ref":"","in":"body","required":true},{"name":"season[name]","_id":"5886737b9321a50f00f3ead3","ref":"","in":"body","required":true,"desc":"Season name (eg: 2017-2018)","default":"","type":"string"},{"ref":"","in":"body","required":true,"desc":"Subseason name (eg: Regular Season)","default":"","type":"string","name":"subseason[name]","_id":"5886737b9321a50f00f3ead2"},{"in":"body","required":false,"desc":"ID of Team of which to create new instance of","default":"","type":"int","name":"node[team_id]","_id":"588674209321a50f00f3eade","ref":""},{"desc":"Name of team if team does not already exist","default":"","type":"string","name":"team[name]","_id":"5886737b9321a50f00f3ead8","ref":"","in":"body","required":false},{"name":"team[button_title]","_id":"5886737b9321a50f00f3ead7","ref":"","in":"body","required":false,"desc":"Button title of team if team does not already exist","default":"","type":"string"},{"ref":"","in":"body","required":false,"desc":"Abbreviation of team name if team does not already exist","default":"","type":"string","name":"team[abbrev]","_id":"5886737b9321a50f00f3ead6"},{"default":"","type":"string","name":"team[primary_color]","_id":"5886737b9321a50f00f3ead5","ref":"","in":"body","required":false,"desc":"Team primary color if team does not already exist"},{"default":"","type":"string","name":"team[secondary_color]","_id":"5886737b9321a50f00f3ead4","ref":"","in":"body","required":false,"desc":"Team secondary color if team does not already exist"}],"results":{"codes":[{"code":"{\n    \"id\": 1930618,\n    \"created_at\": \"2016-04-22T09:00:25-07:00\",\n    \"updated_at\": \"2016-04-22T09:00:25-07:00\",\n    \"team_id\": 1413546,\n    \"affects_standings\": true,\n    \"name\": \"API TEST TEAM\",\n    \"roster_id\": 1892176,\n    \"opponent\": null,\n    \"parent_team_instance_id\": null,\n    \"image_id\": null,\n    \"abbrev\": \"ATT\",\n    \"primary_color\": \"FFFFFF\",\n    \"secondary_color\": \"AAAAAA\",\n    \"button_title\": \"API TEAM\",\n    \"gender\": \"male\",\n    \"management_team_id\": null,\n    \"team\": {\n        \"id\": 1413546,\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"image_id\": null,\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\",\n        \"gender\": null,\n        \"created_at\": \"2016-04-22T09:00:25-07:00\",\n        \"updated_at\": \"2016-04-22T09:00:25-07:00\",\n        \"sport_id\": 1,\n        \"opponent\": null,\n        \"parent_team_id\": null,\n        \"ios_whitelabel_url\": null,\n        \"android_whitelabel_url\": null,\n        \"sites\": [\n            {\n                \"id\": 11953,\n                \"domain_id\": 1149,\n                \"domain_name\": \"sportngin.com\",\n                \"subdomain\": \"apidemo\",\n                \"product_id\": 14,\n                \"name\": \"Sport Ngin API Demo Site\",\n                \"short_name\": \"Sport Ngin API Demo Site\",\n                \"created_on\": \"2016-02-24T06:32:26-08:00\",\n                \"updated_on\": \"2016-04-08T10:04:54-07:00\",\n                \"created_by_user_id\": 3156422,\n                \"updated_by_user_id\": null,\n                \"timezone\": \"US/Central\",\n                \"twitter_user_id\": null,\n                \"layout_theme_id\": 51,\n                \"secure_subdomain\": \"apidemo\",\n                \"address_id\": 4447713,\n                \"membership_privacy\": \"open\",\n                \"membership_grace_period\": 1,\n                \"boss_billing_account_id\": null,\n                \"boss_organization_id\": 27743\n            }\n        ],\n        \"leagues\": [],\n        \"thumbnails\": {},\n        \"thumbnails_ssl\": {},\n        \"current_subseason_ids\": [\n            291621\n        ],\n        \"seasons\": [\n            {\n                \"id\": 267440,\n                \"name\": \"2016\",\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                \"solo_team_league_id\": 199530,\n                \"has_metadata\": null,\n                \"show_shared_schedule\": false,\n                \"stat_preference\": {\n                    \"id\": 292407,\n                    \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"created_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"game_defaults\": {\n                        \"auto_navigate_to_play_details\": true,\n                        \"field_of_play_enabled\": false,\n                        \"game_misconduct_time\": 0,\n                        \"ice_hockey_goalie_order_by\": null,\n                        \"ice_hockey_goalie_order_by_secondary\": null,\n                        \"ice_hockey_goalie_order_dir\": null,\n                        \"ice_hockey_goalie_order_dir_secondary\": null,\n                        \"ice_hockey_goalie_stat_qualify_by\": null,\n                        \"ice_hockey_goalie_stat_qualify_val\": null,\n                        \"ice_hockey_skater_order_by\": null,\n                        \"ice_hockey_skater_order_by_secondary\": null,\n                        \"ice_hockey_skater_order_dir\": null,\n                        \"ice_hockey_skater_order_dir_secondary\": null,\n                        \"ice_hockey_skater_stat_qualify_by\": null,\n                        \"ice_hockey_skater_stat_qualify_val\": null,\n                        \"ice_hockey_team_scoring_order_by\": \"pts\",\n                        \"ice_hockey_team_scoring_order_by_secondary\": null,\n                        \"ice_hockey_team_scoring_order_dir\": \"desc\",\n                        \"ice_hockey_team_scoring_order_dir_secondary\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_by\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_val\": null,\n                        \"ice_hockey_team_stats_order_by\": null,\n                        \"ice_hockey_team_stats_order_by_secondary\": null,\n                        \"ice_hockey_team_stats_order_dir\": null,\n                        \"ice_hockey_team_stats_order_dir_secondary\": null,\n                        \"ice_hockey_team_stats_stat_qualify_by\": null,\n                        \"ice_hockey_team_stats_stat_qualify_val\": null,\n                        \"intermission_length\": 1,\n                        \"major_adjustment_time\": 0,\n                        \"major_penalty_time\": 5,\n                        \"match_penalty_time\": 5,\n                        \"max_goal_differential\": 0,\n                        \"max_player_major_penalties\": 2,\n                        \"max_player_penalties\": 5,\n                        \"max_team_penalties\": 15,\n                        \"minor_adjustment_time\": 0,\n                        \"minor_penalty_time\": 2,\n                        \"misconduct_time\": 10,\n                        \"overtime_intervals\": 2,\n                        \"overtime_length\": \"5\",\n                        \"post_live_updates\": true,\n                        \"regulation_time_intervals\": null,\n                        \"shootout_enabled\": false,\n                        \"stop_run_time\": true,\n                        \"time_interval_name\": \"period\",\n                        \"time_intervals\": [\n                            \"20\",\n                            \"20\",\n                            \"20\"\n                        ],\n                        \"timeout_time\": 1,\n                        \"timeouts\": 1,\n                        \"track_goal_types\": true,\n                        \"track_player_sog\": true,\n                        \"warmup_length\": 5\n                    },\n                    \"season_id\": 267440,\n                    \"original_scorer_can_edit\": null,\n                    \"force_real_time_scoring\": false,\n                    \"stat_tool_id\": 1848623,\n                    \"stats_can_be_unlinked\": null,\n                    \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n                    \"can_edit_final\": \"league_owner\",\n                    \"traded_player_stats\": null,\n                    \"game_sheet_auto_summary_enabled\": true,\n                    \"visible_stats\": \"league_xor_division\"\n                },\n                \"subseasons\": [\n                    {\n                        \"id\": 291621,\n                        \"name\": \"Regular Season\",\n                        \"season_id\": 267440,\n                        \"position\": 1,\n                        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"updated_at\": \"2016-04-20T11:53:00-07:00\",\n                        \"snl_scoring_enabled\": true,\n                        \"statistic_grouping_id\": 417884,\n                        \"workers_completed\": null,\n                        \"standing_preference\": null,\n                        \"live_scoring_stat_configuration\": {\n                            \"show_plus_minus\": null,\n                            \"fair_play_points\": false\n                        }\n                    }\n                ]\n            }\n        ],\n        \"subseason_team_instance_mapping\": [\n            {\n                \"subseason_id\": 291621,\n                \"team_instance_id\": 1930618\n            }\n        ],\n        \"league_name\": null,\n        \"site_name\": \"Sport Ngin API Demo Site\",\n        \"sport_name\": \"Ice Hockey\"\n    },\n    \"thumbnails\": {},\n    \"subseason_ids\": [\n        291621\n    ]\n}","name":"","status":200,"language":"json"}]}},"githubsync":"","link_external":false,"link_url":"","excerpt":"The Create method accepts a single Team Instance (see attributes above) and creates a new record in SportsEngine.  A Single Team (aka Solo Team) is not tied to a particular parent organization. To create a Team Instance independent of a league, the endpoint does not require a `subseason_id` or a `league_instance_id`.\n\n###Parameters","project":"5641217e0ee5370d00da636d","type":"post","childrenPages":[]}

postTeam Instances Create (no league)

The Create method accepts a single Team Instance (see attributes above) and creates a new record in SportsEngine. A Single Team (aka Solo Team) is not tied to a particular parent organization. To create a Team Instance independent of a league, the endpoint does not require a `subseason_id` or a `league_instance_id`. ###Parameters

Body Params

parent_node_id:

required

integer

ID of the node beneath which the team will be placed

existing_or_new:

required

stringexisting

Denotes whether the new Team Instance will be created under a new or existing Team

top_new_team_template_id:

integer

Top template for team page if new team

top_existing_team_template_id:

integer

Top template for team page if existing team

bottom_new_team_template_id:

integer

Bottom template for team page if new team

bottom_existing_team_template_id:

integer

Bottom template for team page if existing team

league[sport_id]:

required

integer

Sport ID for the team being created

season[name]:

required

string

Season name (eg: 2017-2018)

subseason[name]:

required

string

Subseason name (eg: Regular Season)

node[team_id]:

integer

ID of Team of which to create new instance of

team[name]:

string

Name of team if team does not already exist

team[button_title]:

string

Button title of team if team does not already exist

team[abbrev]:

string

Abbreviation of team name if team does not already exist

team[primary_color]:

string

Team primary color if team does not already exist

team[secondary_color]:

string

Team secondary color if team does not already exist

Definition

Examples

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
    "parent_node_id": 2458074,
    "existing_or_new": "new",
    "top_new_team_template_id": 23220,
    "bottom_new_team_template_id": 23221,
    "season":
    		{
    		"name": "2017-18"
    		},
    "subseason":
    		{
    		"name": "Regular Season"
    		},
    "league":
    		{
    		"sport_id": 1
    		},
    "team":
        {
        "name": "API TEST TEAM",
        "button_title": "API TEAM",
        "abbrev": "ATT",
        "primary_color": "FFFFFF",
        "secondary_color": "AAAAAA"
        }
}
    ' "https://api.sportngin.com/team_instances"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"top_new_team_template_id\": 23220,\n    \"bottom_new_team_template_id\": 23220,\n    \"season\":\n    \t{\n    \t\"name\": \"2017-18\"\n    \t},\n    \"subseason\":\n    \t{\n    \t\"name\": \"Regular Season\"\n    \t},\n    \"league\":\n    \t{\n    \t\"sport_id\": 1\n    \t},\n    \"team\":\n        {\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\"\n        }\n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"top_new_team_template_id\": 23220,\n    \"bottom_new_team_template_id\": 23220,\n    \"season\":\n    \t{\n    \t\"name\": \"2017-18\"\n    \t},\n    \"subseason\":\n    \t{\n    \t\"name\": \"Regular Season\"\n    \t},\n    \"league\":\n    \t{\n    \t\"sport_id\": 1\n    \t},\n    \"team\":\n        {\n        \"name\": \"API TEST TEAM\",\n        \"button_title\": \"API TEAM\",\n        \"abbrev\": \"ATT\",\n        \"primary_color\": \"FFFFFF\",\n        \"secondary_color\": \"AAAAAA\"\n        }\n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
    "parent_node_id": 2458074,
    "top_new_team_template_id": 23220,
    "bottom_new_team_template_id": 23221,
    "season":
    		{
    		"name": "2017-18"
    		},
    "subseason":
    		{
    		"name": "Regular Season"
    		},
    "league":
    		{
    		"sport_id": 1
    		},
  	 "node":
    		{
   			"team_id": 1373611
    		}
}
    ' "https://api.sportngin.com/team_instances"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"top_new_team_template_id\": 23220,\n    \"bottom_new_team_template_id\": 23220,\n    \"season\":\n    \t{\n    \t\"name\": \"2017-18\"\n    \t},\n    \"subseason\":\n    \t{\n    \t\"name\": \"Regular Season\"\n    \t},\n    \"league\":\n    \t{\n    \t\"sport_id\": 1\n    \t},\n    \"node\":\n        {\n        \"team_id\": 1373611\n        }\n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"parent_node_id\": 2458074,\n    \"existing_or_new\": \"new\",\n    \"top_new_team_template_id\": 23220,\n    \"bottom_new_team_template_id\": 23220,\n    \"season\":\n    \t{\n    \t\"name\": \"2017-18\"\n    \t},\n    \"subseason\":\n    \t{\n    \t\"name\": \"Regular Season\"\n    \t},\n    \"league\":\n    \t{\n    \t\"sport_id\": 1\n    \t},\n    \"node\":\n        {\n        \"team_id\": 1373611\n        }\n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances")
  .post(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1930618,
    "created_at": "2016-04-22T09:00:25-07:00",
    "updated_at": "2016-04-22T09:00:25-07:00",
    "team_id": 1413546,
    "affects_standings": true,
    "name": "API TEST TEAM",
    "roster_id": 1892176,
    "opponent": null,
    "parent_team_instance_id": null,
    "image_id": null,
    "abbrev": "ATT",
    "primary_color": "FFFFFF",
    "secondary_color": "AAAAAA",
    "button_title": "API TEAM",
    "gender": "male",
    "management_team_id": null,
    "team": {
        "id": 1413546,
        "name": "API TEST TEAM",
        "button_title": "API TEAM",
        "abbrev": "ATT",
        "image_id": null,
        "primary_color": "FFFFFF",
        "secondary_color": "AAAAAA",
        "gender": null,
        "created_at": "2016-04-22T09:00:25-07:00",
        "updated_at": "2016-04-22T09:00:25-07:00",
        "sport_id": 1,
        "opponent": null,
        "parent_team_id": null,
        "ios_whitelabel_url": null,
        "android_whitelabel_url": null,
        "sites": [
            {
                "id": 11953,
                "domain_id": 1149,
                "domain_name": "sportngin.com",
                "subdomain": "apidemo",
                "product_id": 14,
                "name": "Sport Ngin API Demo Site",
                "short_name": "Sport Ngin API Demo Site",
                "created_on": "2016-02-24T06:32:26-08:00",
                "updated_on": "2016-04-08T10:04:54-07:00",
                "created_by_user_id": 3156422,
                "updated_by_user_id": null,
                "timezone": "US/Central",
                "twitter_user_id": null,
                "layout_theme_id": 51,
                "secure_subdomain": "apidemo",
                "address_id": 4447713,
                "membership_privacy": "open",
                "membership_grace_period": 1,
                "boss_billing_account_id": null,
                "boss_organization_id": 27743
            }
        ],
        "leagues": [],
        "thumbnails": {},
        "thumbnails_ssl": {},
        "current_subseason_ids": [
            291621
        ],
        "seasons": [
            {
                "id": 267440,
                "name": "2016",
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-22T12:46:58-07:00",
                "solo_team_league_id": 199530,
                "has_metadata": null,
                "show_shared_schedule": false,
                "stat_preference": {
                    "id": 292407,
                    "updated_on": "2016-03-22T12:46:58-07:00",
                    "created_on": "2016-03-22T12:46:58-07:00",
                    "game_defaults": {
                        "auto_navigate_to_play_details": true,
                        "field_of_play_enabled": false,
                        "game_misconduct_time": 0,
                        "ice_hockey_goalie_order_by": null,
                        "ice_hockey_goalie_order_by_secondary": null,
                        "ice_hockey_goalie_order_dir": null,
                        "ice_hockey_goalie_order_dir_secondary": null,
                        "ice_hockey_goalie_stat_qualify_by": null,
                        "ice_hockey_goalie_stat_qualify_val": null,
                        "ice_hockey_skater_order_by": null,
                        "ice_hockey_skater_order_by_secondary": null,
                        "ice_hockey_skater_order_dir": null,
                        "ice_hockey_skater_order_dir_secondary": null,
                        "ice_hockey_skater_stat_qualify_by": null,
                        "ice_hockey_skater_stat_qualify_val": null,
                        "ice_hockey_team_scoring_order_by": "pts",
                        "ice_hockey_team_scoring_order_by_secondary": null,
                        "ice_hockey_team_scoring_order_dir": "desc",
                        "ice_hockey_team_scoring_order_dir_secondary": null,
                        "ice_hockey_team_scoring_stat_qualify_by": null,
                        "ice_hockey_team_scoring_stat_qualify_val": null,
                        "ice_hockey_team_stats_order_by": null,
                        "ice_hockey_team_stats_order_by_secondary": null,
                        "ice_hockey_team_stats_order_dir": null,
                        "ice_hockey_team_stats_order_dir_secondary": null,
                        "ice_hockey_team_stats_stat_qualify_by": null,
                        "ice_hockey_team_stats_stat_qualify_val": null,
                        "intermission_length": 1,
                        "major_adjustment_time": 0,
                        "major_penalty_time": 5,
                        "match_penalty_time": 5,
                        "max_goal_differential": 0,
                        "max_player_major_penalties": 2,
                        "max_player_penalties": 5,
                        "max_team_penalties": 15,
                        "minor_adjustment_time": 0,
                        "minor_penalty_time": 2,
                        "misconduct_time": 10,
                        "overtime_intervals": 2,
                        "overtime_length": "5",
                        "post_live_updates": true,
                        "regulation_time_intervals": null,
                        "shootout_enabled": false,
                        "stop_run_time": true,
                        "time_interval_name": "period",
                        "time_intervals": [
                            "20",
                            "20",
                            "20"
                        ],
                        "timeout_time": 1,
                        "timeouts": 1,
                        "track_goal_types": true,
                        "track_player_sog": true,
                        "warmup_length": 5
                    },
                    "season_id": 267440,
                    "original_scorer_can_edit": null,
                    "force_real_time_scoring": false,
                    "stat_tool_id": 1848623,
                    "stats_can_be_unlinked": null,
                    "scoring_methods": "--- \n- live\n- mass\n- tabular\n- quick\n",
                    "can_edit_final": "league_owner",
                    "traded_player_stats": null,
                    "game_sheet_auto_summary_enabled": true,
                    "visible_stats": "league_xor_division"
                },
                "subseasons": [
                    {
                        "id": 291621,
                        "name": "Regular Season",
                        "season_id": 267440,
                        "position": 1,
                        "created_at": "2016-03-22T12:46:58-07:00",
                        "updated_at": "2016-04-20T11:53:00-07:00",
                        "snl_scoring_enabled": true,
                        "statistic_grouping_id": 417884,
                        "workers_completed": null,
                        "standing_preference": null,
                        "live_scoring_stat_configuration": {
                            "show_plus_minus": null,
                            "fair_play_points": false
                        }
                    }
                ]
            }
        ],
        "subseason_team_instance_mapping": [
            {
                "subseason_id": 291621,
                "team_instance_id": 1930618
            }
        ],
        "league_name": null,
        "site_name": "Sport Ngin API Demo Site",
        "sport_name": "Ice Hockey"
    },
    "thumbnails": {},
    "subseason_ids": [
        291621
    ]
}

{"_id":"57eeae42cc36920e00bff4ba","__v":0,"category":"56e03709f97d422900d63922","parentDoc":null,"project":"5641217e0ee5370d00da636d","sync_unique":"","updates":[],"user":"56548c568975c70d002ea4b4","api":{"results":{"codes":[{"code":"{\n    \"id\": 1876244,\n    \"created_at\": \"2016-03-22T13:19:31-07:00\",\n    \"updated_at\": \"2016-09-30T11:21:58-07:00\",\n    \"team_id\": 1373612,\n    \"affects_standings\": true,\n    \"name\": \"Buffalo Bison\",\n    \"roster_id\": 1837159,\n    \"opponent\": null,\n    \"parent_team_instance_id\": null,\n    \"image_id\": null,\n    \"abbrev\": \"Buff\",\n    \"primary_color\": \"000000\",\n    \"secondary_color\": \"000000\",\n    \"button_title\": \"Buff\",\n    \"gender\": \"male\",\n    \"management_team_id\": null,\n    \"team\": {\n        \"id\": 1373612,\n        \"name\": \"Buffalo Bison\",\n        \"button_title\": \"Buffalo\",\n        \"abbrev\": \"Buff\",\n        \"image_id\": null,\n        \"primary_color\": \"000000\",\n        \"secondary_color\": \"000000\",\n        \"gender\": \"male\",\n        \"created_at\": \"2016-03-22T13:06:41-07:00\",\n        \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n        \"sport_id\": 1,\n        \"opponent\": null,\n        \"parent_team_id\": null,\n        \"ios_whitelabel_url\": null,\n        \"android_whitelabel_url\": null,\n        \"sites\": [\n            {\n                \"id\": 11953,\n                \"domain_id\": 1149,\n                \"domain_name\": \"sportngin.com\",\n                \"subdomain\": \"apidemo\",\n                \"product_id\": 14,\n                \"name\": \"Sport Ngin API Demo Site\",\n                \"short_name\": \"Sport Ngin API Demo Site\",\n                \"created_on\": \"2016-02-24T06:32:26-08:00\",\n                \"updated_on\": \"2016-09-29T07:59:17-07:00\",\n                \"created_by_user_id\": 3156422,\n                \"updated_by_user_id\": 3646297,\n                \"timezone\": \"America/Chicago\",\n                \"twitter_user_id\": null,\n                \"layout_theme_id\": 53,\n                \"secure_subdomain\": \"apidemo\",\n                \"address_id\": 4447713,\n                \"membership_privacy\": \"open\",\n                \"membership_grace_period\": 1,\n                \"boss_billing_account_id\": null,\n                \"boss_organization_id\": 27743\n            }\n        ],\n        \"leagues\": [\n            {\n                \"id\": 27737,\n                \"name\": \"Eastern League\",\n                \"current_subseason_id\": 291621,\n                \"site_id\": 11953,\n                \"sport_id\": 1,\n                \"image_id\": null,\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-05-02T13:29:58-07:00\",\n                \"button_title\": \"Eastern\",\n                \"primary_color\": \"00AEEF\",\n                \"secondary_color\": \"666666\",\n                \"gender\": \"male\",\n                \"abbrev\": \"East\",\n                \"score_ribbon\": false,\n                \"tweet_games\": null,\n                \"game_sheet_label\": \"gamesheet\"\n            }\n        ],\n        \"thumbnails\": {},\n        \"thumbnails_ssl\": {},\n        \"current_subseason_ids\": [\n            291621\n        ],\n        \"seasons\": [\n            ...","language":"json","status":200,"name":""}]},"settings":"","url":"/team_instances/:id","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X PUT -H \"Authorization: Bearer ACCESS_TOKEN  \" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" -H \"Content-Type: application/json\" -d '{\n\t\"button_title\": \"Buff\"\n}\n}' \"https://api.sportngin.com/team_instances/1876244\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances/1876244\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\nrequest[\"content-type\"] = 'application/json'\nrequest.body = \"{\\n    \\\"button_title\\\": \\\"Buff\\\" \\n}\"\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n    \\\"button_title\\\": \\\"Buff\\\" \\n}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances/1876244\")\n  .put(body)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .addHeader(\"content-type\", \"application/json\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"put","params":[{"_id":"577e8f45a74eb40e00d97b62","ref":"","in":"path","required":true,"desc":"Id of TeamInstance to update","default":"","type":"int","name":"id"}]},"createdAt":"2016-09-30T18:26:10.830Z","excerpt":"The Update method updates the provided fields for a given `id`.\n\n###Parameters","githubsync":"","hidden":false,"isReference":true,"link_external":false,"order":19,"type":"put","title":"Team Instances Update","version":"56cca51eca43550b002813fa","body":"","link_url":"","slug":"team-instances-update","childrenPages":[]}

putTeam Instances Update

The Update method updates the provided fields for a given `id`. ###Parameters

Path Params

id:

required

integer

Id of TeamInstance to update

Definition

Examples

curl -X PUT -H "Authorization: Bearer ACCESS_TOKEN  " -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" -H "Content-Type: application/json" -d '{
	"button_title": "Buff"
}
}' "https://api.sportngin.com/team_instances/1876244"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances/1876244")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'
request["content-type"] = 'application/json'
request.body = "{\n    \"button_title\": \"Buff\" \n}"

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"button_title\": \"Buff\" \n}");
Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances/1876244")
  .put(body)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1876244,
    "created_at": "2016-03-22T13:19:31-07:00",
    "updated_at": "2016-09-30T11:21:58-07:00",
    "team_id": 1373612,
    "affects_standings": true,
    "name": "Buffalo Bison",
    "roster_id": 1837159,
    "opponent": null,
    "parent_team_instance_id": null,
    "image_id": null,
    "abbrev": "Buff",
    "primary_color": "000000",
    "secondary_color": "000000",
    "button_title": "Buff",
    "gender": "male",
    "management_team_id": null,
    "team": {
        "id": 1373612,
        "name": "Buffalo Bison",
        "button_title": "Buffalo",
        "abbrev": "Buff",
        "image_id": null,
        "primary_color": "000000",
        "secondary_color": "000000",
        "gender": "male",
        "created_at": "2016-03-22T13:06:41-07:00",
        "updated_at": "2016-03-23T09:34:28-07:00",
        "sport_id": 1,
        "opponent": null,
        "parent_team_id": null,
        "ios_whitelabel_url": null,
        "android_whitelabel_url": null,
        "sites": [
            {
                "id": 11953,
                "domain_id": 1149,
                "domain_name": "sportngin.com",
                "subdomain": "apidemo",
                "product_id": 14,
                "name": "Sport Ngin API Demo Site",
                "short_name": "Sport Ngin API Demo Site",
                "created_on": "2016-02-24T06:32:26-08:00",
                "updated_on": "2016-09-29T07:59:17-07:00",
                "created_by_user_id": 3156422,
                "updated_by_user_id": 3646297,
                "timezone": "America/Chicago",
                "twitter_user_id": null,
                "layout_theme_id": 53,
                "secure_subdomain": "apidemo",
                "address_id": 4447713,
                "membership_privacy": "open",
                "membership_grace_period": 1,
                "boss_billing_account_id": null,
                "boss_organization_id": 27743
            }
        ],
        "leagues": [
            {
                "id": 27737,
                "name": "Eastern League",
                "current_subseason_id": 291621,
                "site_id": 11953,
                "sport_id": 1,
                "image_id": null,
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-05-02T13:29:58-07:00",
                "button_title": "Eastern",
                "primary_color": "00AEEF",
                "secondary_color": "666666",
                "gender": "male",
                "abbrev": "East",
                "score_ribbon": false,
                "tweet_games": null,
                "game_sheet_label": "gamesheet"
            }
        ],
        "thumbnails": {},
        "thumbnails_ssl": {},
        "current_subseason_ids": [
            291621
        ],
        "seasons": [
            ...

{"_id":"57eea7c1cc36920e00bff4b7","body":"","hidden":false,"slug":"team-instances-delete","excerpt":"The Delete method permanently deletes the associated TeamInstance record in SportsEngine.  *This method takes action upon initial invocation and cannot be reversed.*\n\n###Parameters","project":"5641217e0ee5370d00da636d","sync_unique":"","parentDoc":null,"title":"Team Instances Delete","__v":0,"api":{"method":"delete","params":[{"desc":"Id belonging to the team_instance of interest","default":"","type":"int","name":"id","_id":"57114eae5ba0d80e00f51614","ref":"","in":"path","required":true}],"results":{"codes":[{"language":"json","code":"{\n    \"id\": 1876243,\n    \"created_at\": \"2016-03-22T13:19:12-07:00\",\n    \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n    \"team_id\": 1373611,\n    \"affects_standings\": true,\n    \"name\": \"Boston Bears\",\n    \"roster_id\": 1837158,\n    \"opponent\": null,\n    \"parent_team_instance_id\": null,\n    \"image_id\": null,\n    \"abbrev\": \"Bos\",\n    \"primary_color\": \"000000\",\n    \"secondary_color\": \"000000\",\n    \"button_title\": \"Boston\",\n    \"gender\": \"male\",\n    \"management_team_id\": null,\n    \"team\": {\n        \"id\": 1373611,\n        \"name\": \"Boston Bears\",\n        \"button_title\": \"Boston\",\n        \"abbrev\": \"Bos\",\n        \"image_id\": null,\n        \"primary_color\": \"000000\",\n        \"secondary_color\": \"000000\",\n        \"gender\": \"male\",\n        \"created_at\": \"2016-03-22T13:06:41-07:00\",\n        \"updated_at\": \"2016-03-23T09:34:28-07:00\",\n        \"sport_id\": 1,\n        \"opponent\": null,\n        \"parent_team_id\": null,\n        \"ios_whitelabel_url\": null,\n        \"android_whitelabel_url\": null,\n        \"sites\": [\n            {\n                \"id\": 11953,\n                \"domain_id\": 1149,\n                \"domain_name\": \"sportngin.com\",\n                \"subdomain\": \"apidemo\",\n                \"product_id\": 14,\n                \"name\": \"Sport Ngin API Demo Site\",\n                \"short_name\": \"Sport Ngin API Demo Site\",\n                \"created_on\": \"2016-02-24T06:32:26-08:00\",\n                \"updated_on\": \"2016-04-08T10:04:54-07:00\",\n                \"created_by_user_id\": 3156422,\n                \"updated_by_user_id\": null,\n                \"timezone\": \"US/Central\",\n                \"twitter_user_id\": null,\n                \"layout_theme_id\": 51,\n                \"secure_subdomain\": \"apidemo\",\n                \"address_id\": 4447713,\n                \"membership_privacy\": \"open\",\n                \"membership_grace_period\": 1,\n                \"boss_billing_account_id\": null,\n                \"boss_organization_id\": 27743\n            }\n        ],\n        \"leagues\": [\n            {\n                \"id\": 27737,\n                \"name\": \"Eastern League\",\n                \"current_subseason_id\": 291621,\n                \"site_id\": 11953,\n                \"sport_id\": 1,\n                \"image_id\": null,\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-24T07:20:49-07:00\",\n                \"button_title\": \"Eastern\",\n                \"primary_color\": \"00AEEF\",\n                \"secondary_color\": \"666666\",\n                \"gender\": \"male\",\n                \"abbrev\": \"East\",\n                \"score_ribbon\": false,\n                \"tweet_games\": null,\n                \"game_sheet_label\": \"gamesheet\"\n            }\n        ],\n        \"thumbnails\": {},\n        \"thumbnails_ssl\": {},\n        \"current_subseason_ids\": [\n            291621\n        ],\n        \"seasons\": [\n            {\n                \"id\": 267440,\n                \"name\": \"2016\",\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                \"solo_team_league_id\": null,\n                \"has_metadata\": null,\n                \"show_shared_schedule\": false,\n                \"stat_preference\": {\n                    \"id\": 292407,\n                    \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"created_on\": \"2016-03-22T12:46:58-07:00\",\n                    \"game_defaults\": {\n                        \"auto_navigate_to_play_details\": true,\n                        \"field_of_play_enabled\": false,\n                        \"game_misconduct_time\": 0,\n                        \"ice_hockey_goalie_order_by\": null,\n                        \"ice_hockey_goalie_order_by_secondary\": null,\n                        \"ice_hockey_goalie_order_dir\": null,\n                        \"ice_hockey_goalie_order_dir_secondary\": null,\n                        \"ice_hockey_goalie_stat_qualify_by\": null,\n                        \"ice_hockey_goalie_stat_qualify_val\": null,\n                        \"ice_hockey_skater_order_by\": null,\n                        \"ice_hockey_skater_order_by_secondary\": null,\n                        \"ice_hockey_skater_order_dir\": null,\n                        \"ice_hockey_skater_order_dir_secondary\": null,\n                        \"ice_hockey_skater_stat_qualify_by\": null,\n                        \"ice_hockey_skater_stat_qualify_val\": null,\n                        \"ice_hockey_team_scoring_order_by\": \"pts\",\n                        \"ice_hockey_team_scoring_order_by_secondary\": null,\n                        \"ice_hockey_team_scoring_order_dir\": \"desc\",\n                        \"ice_hockey_team_scoring_order_dir_secondary\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_by\": null,\n                        \"ice_hockey_team_scoring_stat_qualify_val\": null,\n                        \"ice_hockey_team_stats_order_by\": null,\n                        \"ice_hockey_team_stats_order_by_secondary\": null,\n                        \"ice_hockey_team_stats_order_dir\": null,\n                        \"ice_hockey_team_stats_order_dir_secondary\": null,\n                        \"ice_hockey_team_stats_stat_qualify_by\": null,\n                        \"ice_hockey_team_stats_stat_qualify_val\": null,\n                        \"intermission_length\": 1,\n                        \"major_adjustment_time\": 0,\n                        \"major_penalty_time\": 5,\n                        \"match_penalty_time\": 5,\n                        \"max_goal_differential\": 0,\n                        \"max_player_major_penalties\": 2,\n                        \"max_player_penalties\": 5,\n                        \"max_team_penalties\": 15,\n                        \"minor_adjustment_time\": 0,\n                        \"minor_penalty_time\": 2,\n                        \"misconduct_time\": 10,\n                        \"overtime_intervals\": 2,\n                        \"overtime_length\": \"5\",\n                        \"post_live_updates\": true,\n                        \"regulation_time_intervals\": null,\n                        \"shootout_enabled\": false,\n                        \"stop_run_time\": true,\n                        \"time_interval_name\": \"period\",\n                        \"time_intervals\": [\n                            \"20\",\n                            \"20\",\n                            \"20\"\n                        ],\n                        \"timeout_time\": 1,\n                        \"timeouts\": 1,\n                        \"track_goal_types\": true,\n                        \"track_player_sog\": true,\n                        \"warmup_length\": 5\n                    },\n                    \"season_id\": 267440,\n                    \"original_scorer_can_edit\": null,\n                    \"force_real_time_scoring\": false,\n                    \"stat_tool_id\": 1848623,\n                    \"stats_can_be_unlinked\": null,\n                    \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n                    \"can_edit_final\": \"league_owner\",\n                    \"traded_player_stats\": null,\n                    \"game_sheet_auto_summary_enabled\": true,\n                    \"visible_stats\": \"league_xor_division\"\n                },\n                \"subseasons\": [\n                    {\n                        \"id\": 291621,\n                        \"name\": \"Regular Season\",\n                        \"season_id\": 267440,\n                        \"position\": 1,\n                        \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                        \"updated_at\": \"2016-04-15T11:02:33-07:00\",\n                        \"snl_scoring_enabled\": true,\n                        \"statistic_grouping_id\": 417884,\n                        \"workers_completed\": null,\n                        \"standing_preference\": {\n                            \"id\": 110425,\n                            \"standing_tool_id\": 1848627,\n                            \"standing_type_id\": 5,\n                            \"standings_aggregation_level\": \"league\",\n                            \"qualifiers\": null,\n                            \"qualifier_limit\": null,\n                            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                            \"winning_team_custom_points\": null,\n                            \"losing_team_custom_points\": null,\n                            \"tied_team_custom_points\": null,\n                            \"label_mapping\": {},\n                            \"extended_fields\": [\n                                \"win_count\",\n                                \"loss_count\",\n                                \"tie_count\",\n                                \"points\"\n                            ],\n                            \"order_rule\": 1,\n                            \"overtime_win_custom_points\": null,\n                            \"overtime_loss_custom_points\": null,\n                            \"overtime_wins_include_in_wins\": true,\n                            \"overtime_losses_include_in_losses\": true,\n                            \"legacy_custom_points\": false\n                        },\n                        \"live_scoring_stat_configuration\": {\n                            \"show_plus_minus\": null,\n                            \"fair_play_points\": false\n                        }\n                    }\n                ]\n            }\n        ],\n        \"subseason_team_instance_mapping\": [\n            {\n                \"subseason_id\": 291621,\n                \"team_instance_id\": 1876243\n            }\n        ],\n        \"league_name\": \"Eastern League\",\n        \"site_name\": \"Sport Ngin API Demo Site\",\n        \"sport_name\": \"Ice Hockey\"\n    },\n    \"thumbnails\": {},\n    \"subseason_ids\": [\n        291621\n    ]\n}","name":"","status":200}]},"settings":"","url":"/team_instances/:id","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X DELETE -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/team_instances/1876243\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/team_instances/1876243\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/team_instances/1876243\")\n  .delete(null)\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]}},"category":"56e03709f97d422900d63922","githubsync":"","isReference":true,"order":20,"type":"delete","version":"56cca51eca43550b002813fa","createdAt":"2016-09-30T17:58:25.835Z","link_external":false,"link_url":"","updates":[],"user":"56548c568975c70d002ea4b4","childrenPages":[]}

deleteTeam Instances Delete

The Delete method permanently deletes the associated TeamInstance record in SportsEngine. *This method takes action upon initial invocation and cannot be reversed.* ###Parameters

Path Params

id:

required

integer

Id belonging to the team_instance of interest

Definition

Examples

curl -X DELETE -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/team_instances/1876243"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/team_instances/1876243")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/team_instances/1876243")
  .delete(null)
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format

{
    "id": 1876243,
    "created_at": "2016-03-22T13:19:12-07:00",
    "updated_at": "2016-03-23T09:34:28-07:00",
    "team_id": 1373611,
    "affects_standings": true,
    "name": "Boston Bears",
    "roster_id": 1837158,
    "opponent": null,
    "parent_team_instance_id": null,
    "image_id": null,
    "abbrev": "Bos",
    "primary_color": "000000",
    "secondary_color": "000000",
    "button_title": "Boston",
    "gender": "male",
    "management_team_id": null,
    "team": {
        "id": 1373611,
        "name": "Boston Bears",
        "button_title": "Boston",
        "abbrev": "Bos",
        "image_id": null,
        "primary_color": "000000",
        "secondary_color": "000000",
        "gender": "male",
        "created_at": "2016-03-22T13:06:41-07:00",
        "updated_at": "2016-03-23T09:34:28-07:00",
        "sport_id": 1,
        "opponent": null,
        "parent_team_id": null,
        "ios_whitelabel_url": null,
        "android_whitelabel_url": null,
        "sites": [
            {
                "id": 11953,
                "domain_id": 1149,
                "domain_name": "sportngin.com",
                "subdomain": "apidemo",
                "product_id": 14,
                "name": "Sport Ngin API Demo Site",
                "short_name": "Sport Ngin API Demo Site",
                "created_on": "2016-02-24T06:32:26-08:00",
                "updated_on": "2016-04-08T10:04:54-07:00",
                "created_by_user_id": 3156422,
                "updated_by_user_id": null,
                "timezone": "US/Central",
                "twitter_user_id": null,
                "layout_theme_id": 51,
                "secure_subdomain": "apidemo",
                "address_id": 4447713,
                "membership_privacy": "open",
                "membership_grace_period": 1,
                "boss_billing_account_id": null,
                "boss_organization_id": 27743
            }
        ],
        "leagues": [
            {
                "id": 27737,
                "name": "Eastern League",
                "current_subseason_id": 291621,
                "site_id": 11953,
                "sport_id": 1,
                "image_id": null,
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-24T07:20:49-07:00",
                "button_title": "Eastern",
                "primary_color": "00AEEF",
                "secondary_color": "666666",
                "gender": "male",
                "abbrev": "East",
                "score_ribbon": false,
                "tweet_games": null,
                "game_sheet_label": "gamesheet"
            }
        ],
        "thumbnails": {},
        "thumbnails_ssl": {},
        "current_subseason_ids": [
            291621
        ],
        "seasons": [
            {
                "id": 267440,
                "name": "2016",
                "created_at": "2016-03-22T12:46:58-07:00",
                "updated_at": "2016-03-22T12:46:58-07:00",
                "solo_team_league_id": null,
                "has_metadata": null,
                "show_shared_schedule": false,
                "stat_preference": {
                    "id": 292407,
                    "updated_on": "2016-03-22T12:46:58-07:00",
                    "created_on": "2016-03-22T12:46:58-07:00",
                    "game_defaults": {
                        "auto_navigate_to_play_details": true,
                        "field_of_play_enabled": false,
                        "game_misconduct_time": 0,
                        "ice_hockey_goalie_order_by": null,
                        "ice_hockey_goalie_order_by_secondary": null,
                        "ice_hockey_goalie_order_dir": null,
                        "ice_hockey_goalie_order_dir_secondary": null,
                        "ice_hockey_goalie_stat_qualify_by": null,
                        "ice_hockey_goalie_stat_qualify_val": null,
                        "ice_hockey_skater_order_by": null,
                        "ice_hockey_skater_order_by_secondary": null,
                        "ice_hockey_skater_order_dir": null,
                        "ice_hockey_skater_order_dir_secondary": null,
                        "ice_hockey_skater_stat_qualify_by": null,
                        "ice_hockey_skater_stat_qualify_val": null,
                        "ice_hockey_team_scoring_order_by": "pts",
                        "ice_hockey_team_scoring_order_by_secondary": null,
                        "ice_hockey_team_scoring_order_dir": "desc",
                        "ice_hockey_team_scoring_order_dir_secondary": null,
                        "ice_hockey_team_scoring_stat_qualify_by": null,
                        "ice_hockey_team_scoring_stat_qualify_val": null,
                        "ice_hockey_team_stats_order_by": null,
                        "ice_hockey_team_stats_order_by_secondary": null,
                        "ice_hockey_team_stats_order_dir": null,
                        "ice_hockey_team_stats_order_dir_secondary": null,
                        "ice_hockey_team_stats_stat_qualify_by": null,
                        "ice_hockey_team_stats_stat_qualify_val": null,
                        "intermission_length": 1,
                        "major_adjustment_time": 0,
                        "major_penalty_time": 5,
                        "match_penalty_time": 5,
                        "max_goal_differential": 0,
                        "max_player_major_penalties": 2,
                        "max_player_penalties": 5,
                        "max_team_penalties": 15,
                        "minor_adjustment_time": 0,
                        "minor_penalty_time": 2,
                        "misconduct_time": 10,
                        "overtime_intervals": 2,
                        "overtime_length": "5",
                        "post_live_updates": true,
                        "regulation_time_intervals": null,
                        "shootout_enabled": false,
                        "stop_run_time": true,
                        "time_interval_name": "period",
                        "time_intervals": [
                            "20",
                            "20",
                            "20"
                        ],
                        "timeout_time": 1,
                        "timeouts": 1,
                        "track_goal_types": true,
                        "track_player_sog": true,
                        "warmup_length": 5
                    },
                    "season_id": 267440,
                    "original_scorer_can_edit": null,
                    "force_real_time_scoring": false,
                    "stat_tool_id": 1848623,
                    "stats_can_be_unlinked": null,
                    "scoring_methods": "--- \n- live\n- mass\n- tabular\n- quick\n",
                    "can_edit_final": "league_owner",
                    "traded_player_stats": null,
                    "game_sheet_auto_summary_enabled": true,
                    "visible_stats": "league_xor_division"
                },
                "subseasons": [
                    {
                        "id": 291621,
                        "name": "Regular Season",
                        "season_id": 267440,
                        "position": 1,
                        "created_at": "2016-03-22T12:46:58-07:00",
                        "updated_at": "2016-04-15T11:02:33-07:00",
                        "snl_scoring_enabled": true,
                        "statistic_grouping_id": 417884,
                        "workers_completed": null,
                        "standing_preference": {
                            "id": 110425,
                            "standing_tool_id": 1848627,
                            "standing_type_id": 5,
                            "standings_aggregation_level": "league",
                            "qualifiers": null,
                            "qualifier_limit": null,
                            "created_at": "2016-03-22T12:46:58-07:00",
                            "updated_at": "2016-03-22T12:46:58-07:00",
                            "winning_team_custom_points": null,
                            "losing_team_custom_points": null,
                            "tied_team_custom_points": null,
                            "label_mapping": {},
                            "extended_fields": [
                                "win_count",
                                "loss_count",
                                "tie_count",
                                "points"
                            ],
                            "order_rule": 1,
                            "overtime_win_custom_points": null,
                            "overtime_loss_custom_points": null,
                            "overtime_wins_include_in_wins": true,
                            "overtime_losses_include_in_losses": true,
                            "legacy_custom_points": false
                        },
                        "live_scoring_stat_configuration": {
                            "show_plus_minus": null,
                            "fair_play_points": false
                        }
                    }
                ]
            }
        ],
        "subseason_team_instance_mapping": [
            {
                "subseason_id": 291621,
                "team_instance_id": 1876243
            }
        ],
        "league_name": "Eastern League",
        "site_name": "Sport Ngin API Demo Site",
        "sport_name": "Ice Hockey"
    },
    "thumbnails": {},
    "subseason_ids": [
        291621
    ]
}

{"_id":"56f417d60f1f970e006e24a1","parentDoc":null,"sync_unique":"","__v":4,"editedParams2":true,"excerpt":"The Show method returns a single Season for a given `id`.\n\n###Parameters","hidden":false,"link_url":"","order":21,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer ACCESS_TOKEN\" -H \"Accept: application/json\" -H \"NGIN-API-VERSION: 0.1\" \"https://api.sportngin.com/seasons/267440\""},{"language":"ruby","code":"require 'uri'\nrequire 'net/http'\n\nurl = URI(\"https://api.sportngin.com/seasons/267440\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"authorization\"] = 'Bearer ACCESS_TOKEN'\nrequest[\"accept\"] = 'application/json'\nrequest[\"ngin-api-version\"] = '0.1'\n\nresponse = http.request(request)\nputs response.read_body"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://api.sportngin.com/seasons/267440\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer ACCESS_TOKEN\")\n  .addHeader(\"accept\", \"application/json\")\n  .addHeader(\"ngin-api-version\", \"0.1\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"default":"","type":"int","name":"id","in":"path","_id":"56fd7f18e7f3080e008e3e85","ref":"","required":true,"desc":""}],"results":{"codes":[{"language":"json","code":"{\n    \"id\": 267440,\n    \"name\": \"2016\",\n    \"created_at\": \"2016-03-22T12:46:58-07:00\",\n    \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n    \"solo_team_league_id\": null,\n    \"has_metadata\": null,\n    \"show_shared_schedule\": false,\n    \"stat_preference\": {\n        \"id\": 292407,\n        \"updated_on\": \"2016-03-22T12:46:58-07:00\",\n        \"created_on\": \"2016-03-22T12:46:58-07:00\",\n        \"game_defaults\": {\n            \"auto_navigate_to_play_details\": true,\n            \"field_of_play_enabled\": false,\n            \"game_misconduct_time\": 0,\n            \"ice_hockey_goalie_order_by\": null,\n            \"ice_hockey_goalie_order_by_secondary\": null,\n            \"ice_hockey_goalie_order_dir\": null,\n            \"ice_hockey_goalie_order_dir_secondary\": null,\n            \"ice_hockey_goalie_stat_qualify_by\": null,\n            \"ice_hockey_goalie_stat_qualify_val\": null,\n            \"ice_hockey_skater_order_by\": null,\n            \"ice_hockey_skater_order_by_secondary\": null,\n            \"ice_hockey_skater_order_dir\": null,\n            \"ice_hockey_skater_order_dir_secondary\": null,\n            \"ice_hockey_skater_stat_qualify_by\": null,\n            \"ice_hockey_skater_stat_qualify_val\": null,\n            \"ice_hockey_team_scoring_order_by\": \"pts\",\n            \"ice_hockey_team_scoring_order_by_secondary\": null,\n            \"ice_hockey_team_scoring_order_dir\": \"desc\",\n            \"ice_hockey_team_scoring_order_dir_secondary\": null,\n            \"ice_hockey_team_scoring_stat_qualify_by\": null,\n            \"ice_hockey_team_scoring_stat_qualify_val\": null,\n            \"ice_hockey_team_stats_order_by\": null,\n            \"ice_hockey_team_stats_order_by_secondary\": null,\n            \"ice_hockey_team_stats_order_dir\": null,\n            \"ice_hockey_team_stats_order_dir_secondary\": null,\n            \"ice_hockey_team_stats_stat_qualify_by\": null,\n            \"ice_hockey_team_stats_stat_qualify_val\": null,\n            \"intermission_length\": 1,\n            \"major_adjustment_time\": 0,\n            \"major_penalty_time\": 5,\n            \"match_penalty_time\": 5,\n            \"max_goal_differential\": 0,\n            \"max_player_major_penalties\": 2,\n            \"max_player_penalties\": 5,\n            \"max_team_penalties\": 15,\n            \"minor_adjustment_time\": 0,\n            \"minor_penalty_time\": 2,\n            \"misconduct_time\": 10,\n            \"overtime_intervals\": 2,\n            \"overtime_length\": \"5\",\n            \"post_live_updates\": true,\n            \"regulation_time_intervals\": null,\n            \"shootout_enabled\": false,\n            \"stop_run_time\": true,\n            \"time_interval_name\": \"period\",\n            \"time_intervals\": [\n                \"20\",\n                \"20\",\n                \"20\"\n            ],\n            \"timeout_time\": 1,\n            \"timeouts\": 1,\n            \"track_goal_types\": true,\n            \"track_player_sog\": true,\n            \"warmup_length\": 5\n        },\n        \"season_id\": 267440,\n        \"original_scorer_can_edit\": null,\n        \"force_real_time_scoring\": false,\n        \"stat_tool_id\": 1848623,\n        \"stats_can_be_unlinked\": null,\n        \"scoring_methods\": \"--- \\n- live\\n- mass\\n- tabular\\n- quick\\n\",\n        \"can_edit_final\": \"league_owner\",\n        \"traded_player_stats\": null,\n        \"game_sheet_auto_summary_enabled\": true,\n        \"visible_stats\": \"league_xor_division\"\n    },\n    \"subseasons\": [\n        {\n            \"id\": 291621,\n            \"name\": \"Regular Season\",\n            \"season_id\": 267440,\n            \"position\": 1,\n            \"created_at\": \"2016-03-22T12:46:58-07:00\",\n            \"updated_at\": \"2016-04-14T09:43:56-07:00\",\n            \"snl_scoring_enabled\": true,\n            \"statistic_grouping_id\": 417884,\n            \"workers_completed\": null,\n            \"standing_preference\": {\n                \"id\": 110425,\n                \"standing_tool_id\": 1848627,\n                \"standing_type_id\": 5,\n                \"standings_aggregation_level\": \"league\",\n                \"qualifiers\": null,\n                \"qualifier_limit\": null,\n                \"created_at\": \"2016-03-22T12:46:58-07:00\",\n                \"updated_at\": \"2016-03-22T12:46:58-07:00\",\n                \"winning_team_custom_points\": null,\n                \"losing_team_custom_points\": null,\n                \"tied_team_custom_points\": null,\n                \"label_mapping\": {},\n                \"extended_fields\": [\n                    \"win_count\",\n                    \"loss_count\",\n                    \"tie_count\",\n                    \"points\"\n                ],\n                \"order_rule\": 1,\n                \"overtime_win_custom_points\": null,\n                \"overtime_loss_custom_points\": null,\n                \"overtime_wins_include_in_wins\": true,\n                \"overtime_losses_include_in_losses\": true,\n                \"legacy_custom_points\": false\n            },\n            \"live_scoring_stat_configuration\": {\n                \"show_plus_minus\": null,\n                \"fair_play_points\": false\n            }\n        }\n    ]\n}","name":"","status":200}]},"settings":"","url":"/seasons/:id","auth":"required"},"editedParams":true,"project":"5641217e0ee5370d00da636d","slug":"seasons-show","type":"get","version":"56cca51eca43550b002813fa","body":"###Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Unique id assigned by NGIN\",\n    \"1-0\": \"name\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Name of the season\",\n    \"2-0\": \"stat_prefence\",\n    \"2-1\": \"Hash\",\n    \"2-2\": \"Information about stat preferences for the season\",\n    \"3-0\": \"roster_enabled\",\n    \"3-1\": \"Boolean\",\n    \"3-2\": \"Whether or not team_instances for the season will have rosters\",\n    \"4-0\": \"schedule_enabled\",\n    \"4-1\": \"Boolean\",\n    \"4-2\": \"Whether or not to display games for this season in the game schedule\",\n    \"5-0\": \"statistics_enabld\",\n    \"5-1\": \"Boolean\",\n    \"5-2\": \"Whether or not to calculate statistics for the season\",\n    \"6-0\": \"created_at\",\n    \"6-1\": \"Datetime\",\n    \"7-0\": \"updated_at\",\n    \"7-1\": \"Datetime\",\n    \"6-2\": \"Timestamp of creation date\",\n    \"7-2\": \"Timestamp of last update\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n###Stat_Preference Hash Attributes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Notes\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Unique id assigned by NGIN\",\n    \"1-0\": \"season_id\",\n    \"1-1\": \"Integer\",\n    \"1-2\": \"id of the season assigned by NGIN\",\n    \"2-0\": \"force_real_time_scoring\",\n    \"2-1\": \"Boolean\",\n    \"2-2\": \"Whether or not to require all scoring to be done with Sport NGIN Live\",\n    \"3-0\": \"original_scorer_can_edit\",\n    \"3-1\": \"Boolean\",\n    \"3-2\": \"Whether or not the original scorer is able to edit the stats\",\n    \"4-0\": \"required_roster_fields\",\n    \"4-1\": \"Array\",\n    \"4-2\": \"List of required fields for rosters\",\n    \"5-0\": \"email_list\",\n    \"5-1\": \"String\",\n    \"5-2\": \"List of emails to send updates to\",\n    \"6-0\": \"email_time\",\n    \"6-1\": \"Datetime\",\n    \"6-2\": \"Time of day to send email updates\",\n    \"7-0\": \"game_defaults\",\n    \"7-1\": \"Hash\",\n    \"7-2\": \"Sport specific defaults for games in this season\",\n    \"8-0\": \"created_on\",\n    \"9-0\": \"updated_on\",\n    \"8-1\": \"Datetime\",\n    \"9-1\": \"Datetime\",\n    \"8-2\": \"Timestamp of creation date\",\n    \"9-2\": \"Timestamp of last update\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Hint\",\n  \"body\": \"Stat_Preference may return other sport specific fields.\"\n}\n[/block]","createdAt":"2016-03-24T16:37:42.300Z","updates":[],"user":"56e71f9edee212320019e731","category":"56e03709f97d422900d63922","githubsync":"","isReference":true,"link_external":false,"title":"Seasons Show","childrenPages":[]}

getSeasons Show

The Show method returns a single Season for a given `id`. ###Parameters

Path Params

id:

required

integer

Attributes

Attribute

Type

Notes

Integer

Unique id assigned by NGIN

name

String

Name of the season

stat_prefence

Hash

Information about stat preferences for the season

roster_enabled

Boolean

Whether or not team_instances for the season will have rosters

schedule_enabled

Boolean

Whether or not to display games for this season in the game schedule

statistics_enabld

Boolean

Whether or not to calculate statistics for the season

created_at

Datetime

Timestamp of creation date

updated_at

Datetime

Timestamp of last update

Stat_Preference Hash Attributes

Attribute

Type

Notes

Integer

Unique id assigned by NGIN

season_id

Integer

id of the season assigned by NGIN

force_real_time_scoring

Boolean

Whether or not to require all scoring to be done with Sport NGIN Live

original_scorer_can_edit

Boolean

Whether or not the original scorer is able to edit the stats

required_roster_fields

Array

List of required fields for rosters

email_list

String

List of emails to send updates to

email_time

Datetime

Time of day to send email updates

game_defaults

Hash

Sport specific defaults for games in this season

created_on

Datetime

Timestamp of creation date

updated_on

Datetime

Timestamp of last update

Hint

Stat_Preference may return other sport specific fields.

Definition

Examples

curl -X GET -H "Authorization: Bearer ACCESS_TOKEN" -H "Accept: application/json" -H "NGIN-API-VERSION: 0.1" "https://api.sportngin.com/seasons/267440"

require 'uri'
require 'net/http'

url = URI("https://api.sportngin.com/seasons/267440")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'Bearer ACCESS_TOKEN'
request["accept"] = 'application/json'
request["ngin-api-version"] = '0.1'

response = http.request(request)
puts response.read_body

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.sportngin.com/seasons/267440")
  .get()
  .addHeader("authorization", "Bearer ACCESS_TOKEN")
  .addHeader("accept", "application/json")
  .addHeader("ngin-api-version", "0.1")
  .build();

Response response = client.newCall(request).execute();

Result Format