Municipality

List, search or filter Municipalities

get/v1/municipalities

Request

  • Base URL: https://go.lts.it/api
  • URL: https://go.lts.it/api/v1/municipalities
  • Auth: one of:
    • HTTP basic and API key in header X-LTS-ClientID
    • HTTP bearer

Query parameters

language'cs' | 'de' | 'en' | 'nl' | 'fr' | 'it' | 'pl' | 'ru'

The preferred language for the API response. Available options include cs, de, en, nl, fr, it, pl, and ru. Note If no language is specified, the API response will include all available languages. Only one language can be passed at a time.

page[size]integer

The number of records per page for the API response. Allows you to control the amount of data returned per page. Default value is 100. Maximum value is 100, unless the 'fields' parameter is passed with only 'rid' field, in this case the page size limit is unlimited.

page[number]integer

The page number for the API response. Allows you to paginate through large data sets by specifying the desired page number. Default value is 1.

lastUpdatestring date-time

Date and time of last change

idsstring
language'cs' | 'de' | 'en' | 'nl' | 'fr' | 'it' | 'pl' | 'ru'
ridsstring
tourismOrganizationRidsstring

The API's filter parameter enables data filtering. To apply multiple filters, connect them using & e.g filter[a]=1&filter[b]=test. The available filters are: <br>filter[lastUpdate] Date filter for last update. Rules:date_format:Y-m-d\TH:i:s.v<br>filter[ids] Rules:multiple, string, size:32<br>filter[language] Filter by language. Rules:string, in:cs,de,en,nl,fr,it,pl,ru<br>filter[rids] Filter Municipality by record Rids. Rules:string, size:32, multiple<br>filter[tourismOrganizationRids] Municipality by tourismOrganizationRids. Rules:string, size:32, multiple

{
  "lastUpdate": "1958-07-11T17",
  "ids": "2CED855ACA8BAD68B96BEB7120BBC63F",
  "language": "nl",
  "rids": "B72A8EC09FA635151CCE847EF8FB1EAA",
  "tourismOrganizationRids": "FF3D8EDCAA4C6CA3ECDA949442EC0983"
}
sortstring

Requests for retrieved resources to be sorted by the value some selected field. Sorting requests may be in ascending (e.g., sort=startDate) or descending order (e.g., sort=-length) by prefixing the field name with a MINUS (U+002D) character. If the sort value includes a language, the language parameter is also required. Sorting is available over (code,name,lastUpdate) the primitive attributes of an endpoint's resources.

fieldsstring

Selects which fields (i.e., attributes or relationships) should be present in returned resource. To exclude a field, add a "-" before its value. Multiple fields can be passed separated by a comma ",". If only "rid" or "id" is passed, pagination size is unlimited by default. (e.g. rid,lastUpdate,code,name.cs,name.de,name.en,name.fr,name.it,name.nl,name.pl,name.ru).

Response

successful operation

successboolean required

Example response

{
  "success": true,
  "data": [
    {
      "rid": "2A1BAF2F372E006B9ECC9B068CAB4776",
      "lastUpdate": "1974-09-05T07",
      "code": "8A9",
      "name": {
        "cs": "Quis.",
        "de": "Minima.",
        "en": "Autem.",
        "fr": "Sed.",
        "it": "In.",
        "nl": "Unde.",
        "pl": "Ab aliquam et.",
        "ru": "Earum."
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.