LARC (1.0.0)

Download OpenAPI specification:Download

Ekkart Kleinod: ekleinod@edgesoft.de URL: https://gitlab.com/opentt/larc-api License: GNU General Public License

Getting the list of authorized racket coverings (LARC).

This API provides means to acquire the list of authorized racket coverings (LARC) of the ITTF.

It is not an official project of the ITTF but a private one.

The API provides read-only access only, there are no means to change the LARCs.

At the moment, the API relies directly on json files, it is not supported by a real REST server. This means, additional header information etc. is not provided. Dynamic content generation (search etc.) is not possible as well. This may change in the future.

LARC

Specific LARC content.

Get list of all LARCs.

Retrieve information of all available larcs.

Responses

Response samples

Content type

application/json

{"_links": [{"id": "self",
"link": "/larcs"
},
{"id": "next",
"link": "/larcs/2022-1"
}
],
"associations": {"_links": [{"id": "self",
"link": "/associations"
}
],
"items": [{"_links": [{"id": "self",
"link": "/associations/ittf"
}
],
"default": true,
"id": "ittf",
"name": "ITTF",
"validity": "current"
},
{"_links": [{"id": "self",
"link": "/associations/dttb"
}
],
"id": "dttb",
"name": "DTTB",
"valid_from": "2021-07-01",
"valid_to": "2022-06-30",
"validity": "season"
}
],
"size": 2
},
"larcs": {"_links": [{"id": "self",
"link": "/larcs"
}
],
"items": [{"_links": [{"id": "self",
"link": "/larcs/2022-1"
}
],
"brands": {"size": 116
},
"coverings": {"size": 1598
},
"id": "2022-1",
"name": "LARC 2022-1",
"valid_for": ["ittf",
"dttb"
],
"valid_from": "2022-01-01",
"valid_to": "2022-03-31"
},
{"_links": [{"id": "self",
"link": "/larcs/2021-3"
}
],
"brands": {"size": 115
},
"coverings": {"size": 1585
},
"id": "2021-3",
"name": "LARC 2021-3",
"valid_for": ["dttb"
],
"valid_from": "2021-10-01",
"valid_to": "2021-12-31"
},
{"_links": [{"id": "self",
"link": "/larcs/2021-2"
}
],
"brands": {"size": 114
},
"coverings": {"size": 1568
},
"id": "2021-2",
"name": "LARC 2021-2",
"valid_for": ["dttb"
],
"valid_from": "2021-07-01",
"valid_to": "2021-09-30"
}
],
"size": 3
},
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
}
}

Get LARC by ID

Retrieve the information of the brand with the matching brand ID.

path Parameters

larcId

required

string^\d{4}-\d{1}|current$

Example: 2022-1

LARC id is a combination of year and the number of the LARC in that year, e.g. 2021-3. Special value "current" for the current LARC is allowed.

Responses

Response samples

Content type

application/json

{"meta": {"api_version": "1.0.0",
"api_root": "https://www.opentt.de/larc/api",
"last_update": "2022-01-01",
"current_larc": "2022-1"
},
"_links": [{"id": "self",
"link": "/larcs/2022-1"
},
{"id": "next",
"link": "/larcs/2022-2"
}
],
"id": "2022-1",
"name": "LARC 2022-1",
"coverings": {"size": "1598"
},
"brands": {"size": 2,
"items": [{"_links": [{"id": "self",
"link": "/brands/856d820b-ce7b-4057-bd38-f78b1e865a1f"
}
],
"coverings": {"_links": [{"id": "self",
"link": "/coverings"
}
],
"items": [{"_links": [{"id": "self",
"link": "/coverings/d30f651d-7bbb-5388-986e-7884f2b94cd4"
}
],
"colors": ["red",
"black"
],
"id": "d30f651d-7bbb-5388-986e-7884f2b94cd4",
"name": "Competition XR3000",
"pimpletype": "in"
}
],
"size": 1
},
"id": "856d820b-ce7b-4057-bd38-f78b1e865a1f",
"name": "Yashima"
},
{"_links": [{"id": "self",
"link": "/brands/203"
}
],
"code": "203",
"coverings": {"_links": [{"id": "self",
"link": "/coverings"
}
],
"items": [{"_links": [{"id": "self",
"link": "/coverings/203-001"
}
],
"code": "203-001",
"colors": ["red",
"black"
],
"id": "203-001",
"name": "Dingtian",
"pimpletype": "in"
},
{"_links": [{"id": "self",
"link": "/coverings/203-002"
}
],
"code": "203-002",
"colors": ["red",
"black"
],
"id": "203-002",
"name": "Zhenhai",
"pimpletype": "in"
}
],
"size": 2
},
"id": "203",
"name": "Young Shine"
}
],
"_links": [{"id": "self",
"link": "/brands"
}
]
},
"valid_for": ["ittf",
"dttb"
],
"valid_from": "2022-01-01",
"valid_to": "2022-03-31",
"colors": {"size": 2,
"items": [{"_links": [{"id": "self",
"link": "/colors/purple"
}
],
"color": {"hex": "#D7BDE2",
"rgb": "215,189,226"
},
"id": "purple"
},
{"_links": [{"id": "self",
"link": "/colors/violet"
}
],
"color": {"hex": "#6C3483",
"rgb": "108,52,131"
},
"id": "violet"
}
],
"_links": [{"id": "self",
"link": "/colors"
}
]
},
"pimpletypes": {"size": 2,
"items": [{"_links": [{"id": "self",
"link": "/pimpletypes/in"
}
],
"id": "in"
},
{"_links": [{"id": "self",
"link": "/pimpletypes/out"
}
],
"id": "out"
}
],
"_links": [{"id": "self",
"link": "/pimpletypes"
}
]
}
}

List

Content lists.

Get list of all LARCs.

Retrieve information of all available larcs.

Responses

Response samples

Content type

application/json

{"_links": [{"id": "self",
"link": "/larcs"
},
{"id": "next",
"link": "/larcs/2022-1"
}
],
"associations": {"_links": [{"id": "self",
"link": "/associations"
}
],
"items": [{"_links": [{"id": "self",
"link": "/associations/ittf"
}
],
"default": true,
"id": "ittf",
"name": "ITTF",
"validity": "current"
},
{"_links": [{"id": "self",
"link": "/associations/dttb"
}
],
"id": "dttb",
"name": "DTTB",
"valid_from": "2021-07-01",
"valid_to": "2022-06-30",
"validity": "season"
}
],
"size": 2
},
"larcs": {"_links": [{"id": "self",
"link": "/larcs"
}
],
"items": [{"_links": [{"id": "self",
"link": "/larcs/2022-1"
}
],
"brands": {"size": 116
},
"coverings": {"size": 1598
},
"id": "2022-1",
"name": "LARC 2022-1",
"valid_for": ["ittf",
"dttb"
],
"valid_from": "2022-01-01",
"valid_to": "2022-03-31"
},
{"_links": [{"id": "self",
"link": "/larcs/2021-3"
}
],
"brands": {"size": 115
},
"coverings": {"size": 1585
},
"id": "2021-3",
"name": "LARC 2021-3",
"valid_for": ["dttb"
],
"valid_from": "2021-10-01",
"valid_to": "2021-12-31"
},
{"_links": [{"id": "self",
"link": "/larcs/2021-2"
}
],
"brands": {"size": 114
},
"coverings": {"size": 1568
},
"id": "2021-2",
"name": "LARC 2021-2",
"valid_for": ["dttb"
],
"valid_from": "2021-07-01",
"valid_to": "2021-09-30"
}
],
"size": 3
},
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
}
}

Get list of all associations.

Retrieve information of all available associations.

Responses

Response samples

Content type

application/json

{"associations": {"_links": [{"id": "self",
"link": "/associations"
},
{"id": "next",
"link": "/associations/dttb"
}
],
"items": [{"_links": [{"id": "self",
"link": "/associations/dttb"
}
],
"id": "dttb",
"name": "DTTB",
"valid_from": "2021-07-01",
"valid_to": "2022-06-30",
"validity": "season"
},
{"_links": [{"id": "self",
"link": "/associations/ittf"
}
],
"default": true,
"id": "ittf",
"name": "ITTF",
"validity": "current"
}
],
"size": 2
},
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
}
}

Get list of all brands.

Retrieve information of all available brands.

Responses

Response samples

Content type

application/json

{"brands": {"_links": [{"id": "self",
"link": "/brands"
}
],
"items": [{"_links": [{"id": "self",
"link": "/brands/115"
}
],
"code": "115",
"coverings": {"size": 7
},
"id": "115",
"name": "61 second"
},
{"_links": [{"id": "self",
"link": "/brands/106"
}
],
"code": "106",
"coverings": {"size": 8
},
"id": "106",
"name": "Air"
}
],
"size": 2
},
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
}
}

Association

Specific association content.

Get list of all associations.

Retrieve information of all available associations.

Responses

Response samples

Content type

application/json

{"associations": {"_links": [{"id": "self",
"link": "/associations"
},
{"id": "next",
"link": "/associations/dttb"
}
],
"items": [{"_links": [{"id": "self",
"link": "/associations/dttb"
}
],
"id": "dttb",
"name": "DTTB",
"valid_from": "2021-07-01",
"valid_to": "2022-06-30",
"validity": "season"
},
{"_links": [{"id": "self",
"link": "/associations/ittf"
}
],
"default": true,
"id": "ittf",
"name": "ITTF",
"validity": "current"
}
],
"size": 2
},
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
}
}

Get association by ID

Retrieve the information of the association with the matching association ID.

path Parameters

associationId

required

string

Example: ittf

Association id is a freely defineable text.

Responses

Response samples

Content type

application/json

{"_links": [{"id": "self",
"link": "/associations/dttb"
},
{"id": "all",
"link": "/associations"
},
{"id": "next",
"link": "/associations/ittf"
}
],
"id": "dttb",
"larcs": ["2022-1",
"2021-3",
"2021-2"
],
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
},
"name": "DTTB",
"seasonstart_month": 7,
"valid_from": "2021-07-01",
"valid_to": "2022-06-30",
"validity": "season"
}

Brand

Specific brand content.

Get list of all brands.

Retrieve information of all available brands.

Responses

Response samples

Content type

application/json

{"brands": {"_links": [{"id": "self",
"link": "/brands"
}
],
"items": [{"_links": [{"id": "self",
"link": "/brands/115"
}
],
"code": "115",
"coverings": {"size": 7
},
"id": "115",
"name": "61 second"
},
{"_links": [{"id": "self",
"link": "/brands/106"
}
],
"code": "106",
"coverings": {"size": 8
},
"id": "106",
"name": "Air"
}
],
"size": 2
},
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
}
}

Get brand by ID

Retrieve the information of the brand with the matching brand ID.

path Parameters

brandId

required

string^\d{1,3}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-...

Example: 203

Unique brand id. ID can be the code. If no code is assigned by the ITTF, a generated UUID is used.

Responses

Response samples

Content type

application/json

{"_links": [{"id": "self",
"link": "/brands/177"
},
{"id": "all",
"link": "/brands"
},
{"id": "prev",
"link": "/brands/176"
},
{"id": "next",
"link": "/brands/179"
}
],
"code": "177",
"colors": {"_links": [{"id": "self",
"link": "/colors"
}
],
"items": [{"_links": [{"id": "self",
"link": "/colors/red"
}
],
"color": {"hex": "#922B21",
"rgb": "146,43,33"
},
"id": "red"
},
{"_links": [{"id": "self",
"link": "/colors/black"
}
],
"color": {"hex": "#000000",
"rgb": "0,0,0"
},
"id": "black"
},
{"_links": [{"id": "self",
"link": "/colors/green"
}
],
"color": {"hex": "#229954",
"rgb": "34,153,84"
},
"id": "green"
},
{"_links": [{"id": "self",
"link": "/colors/blue"
}
],
"color": {"hex": "#3498DB",
"rgb": "52,152,219"
},
"id": "blue"
},
{"_links": [{"id": "self",
"link": "/colors/purple"
}
],
"color": {"hex": "#D7BDE2",
"rgb": "215,189,226"
},
"id": "purple"
},
{"_links": [{"id": "self",
"link": "/colors/violet"
}
],
"color": {"hex": "#6C3483",
"rgb": "108,52,131"
},
"id": "violet"
}
],
"size": 6
},
"coverings": {"_links": [{"id": "self",
"link": "/coverings"
}
],
"items": [{"_links": [{"id": "self",
"link": "/coverings/177-001"
}
],
"code": "177-001",
"colors": ["red",
"black"
],
"id": "177-001",
"name": "A901",
"pimpletype": "in"
},
{"_links": [{"id": "self",
"link": "/coverings/177-002"
}
],
"code": "177-002",
"colors": ["red",
"black"
],
"id": "177-002",
"name": "Z601",
"pimpletype": "in"
}
],
"size": 2
},
"id": "177",
"meta": {"api_root": "https://www.opentt.de/larc/api",
"api_version": "1.0.0",
"current_larc": "2022-1",
"last_update": "2022-01-01"
},
"name": "Arbalest",
"pimpletypes": {"_links": [{"id": "self",
"link": "/pimpletypes"
}
],
"items": [{"_links": [{"id": "self",
"link": "/pimpletypes/in"
}
],
"id": "in"
},
{"_links": [{"id": "self",
"link": "/pimpletypes/out"
}
],
"id": "out"
},
{"_links": [{"id": "self",
"link": "/pimpletypes/long"
}
],
"id": "long"
},
{"_links": [{"id": "self",
"link": "/pimpletypes/anti"
}
],
"id": "anti"
}
],
"size": 4
}
}

LARC (1.0.0)

LARC

Get list of all LARCs.

Responses

Response samples

Get LARC by ID

path Parameters

Responses

Response samples

List

Get list of all LARCs.

Responses

Response samples

Get list of all associations.

Responses

Response samples

Get list of all brands.

Responses

Response samples

Association

Get list of all associations.

Responses

Response samples

Get association by ID

path Parameters

Responses

Response samples

Brand

Get list of all brands.

Responses

Response samples

Get brand by ID

path Parameters

Responses

Response samples

Meta

Get meta information about data and API.

Responses

Response samples