Operation

This operation allow you to get a list of all the municipality's available in the system.

GET

https://{environment}.ulysescloud.com/public/api/{version}/municipality

Request

Property	Type	Required	Path parameter	Default value	Description
countryId	Integer	false	request parameter		Unique identificator of the country.
stateProvId	Integer	false	request parameter		Unique identificator of the stateProv.

Example request

GET https://publicapi-dev.ulysescloud.com/public/api/v1/municipality

Response

Array of Municipality elements.

Entity

Field	Type	Description
id	Integer	id
code	String	Code
name	String	Name
nameI18n	String	NameI18n
stateProv	String	State Province

Example response

[
    {
        "id": 1,
        "code": "051",
        "name": "Agurain/Salvatierra",
        "nameI18n": null,
        "stateProv": {
            "id": 2,
            "code": "ES-VI",
            "name": "Álava",
            "nameI18n": null,
            "country": {
                "id": 199,
                "code": "ESP",
                "name": "SPAIN",
                "nameI18n": "SPAIN"
            }
        }
    },
    {
        "id": 2,
        "code": "001",
        "name": "Alegría-Dulantzi",
        "nameI18n": null,
        "stateProv": {
            "id": 2,
            "code": "ES-VI",
            "name": "Álava",
            "nameI18n": null,
            "country": {
                "id": 199,
                "code": "ESP",
                "name": "SPAIN",
                "nameI18n": "SPAIN"
            }
        }
    },
    {
        "id": 3,
        "code": "002",
        "name": "Amurrio",
        "nameI18n": null,
        "stateProv": {
            "id": 2,
            "code": "ES-VI",
            "name": "Álava",
            "nameI18n": null,
            "country": {
                "id": 199,
                "code": "ESP",
                "name": "SPAIN",
                "nameI18n": "SPAIN"
            }
        }
    } ...
]

Browser not supported