VenueApi

GET /api/venues

Changed on Feb 17, 2023

Request

Base URL
https://vocadb.net (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vocadb/apis/vocadbweb/docs/api/venues/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

querystring

fields'None' | 'AdditionalNames' | 'Description' | 'Events' | 'Names' | 'WebLinks'

startinteger

maxResultsinteger

getTotalCountboolean

nameMatchMode'Auto' | 'Partial' | 'StartsWith' | 'Exact' | 'Words'

lang'Default' | 'Japanese' | 'Romaji' | 'English'

sortRule'None' | 'Name' | 'Distance'

latitudenumber double

longitudenumber double

radiusnumber double

distanceUnit'Kilometers' | 'Miles'

Response

Success

termstring nullable

totalCountinteger

Changes

Feb 17, 2023a58e37404e87 Revision changes
- warning
  added the new Festival enum value to the //// response property for the response status (media type: text/plain)
- warning
  added the new Festival enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new Festival enum value to the //// response property for the response status (media type: text/json)
- warning
  added the new Festival enum value to the //// response property for the response status (media type: text/plain)
- warning
  added the new Festival enum value to the //// response property for the response status (media type: application/json)
- warning
  added the new Festival enum value to the //// response property for the response status (media type: text/json)
- warning
  added the new Festival enum value to the ///// response property for the response status (media type: text/plain)
- warning
  added the new Festival enum value to the ///// response property for the response status (media type: application/json)
- warning
  added the new Festival enum value to the ///// response property for the response status (media type: text/json)

Operation history