Obtener ciudades
API operation: Open the endpoint in Scalar
Usa GET /countries/{country}/cities para listar las ciudades asociadas con un país. La operación es City.findAll.
Las solicitudes pueden usar una clave de API o un token bearer. Los roles 0 y 1 pueden acceder; los resultados se limitan al país indicado y admiten paginación, ordenamiento, filtros y expansión de relaciones. Consulta Solicitud especial de ciudades para conocer los nombres de relación.
Ejemplo de SDK heredado
const response = await ordering.countries(countryId).cities().get()
El nombre del helper del SDK es cities(). Los helpers pueden variar según la versión; comprueba el paquete que utilizas.
Referencia de OpenAPI
Operación: GET /countries/{country}/cities
Parámetros de ruta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
country | integer | Sí | — |
Parámetros de consulta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
params | string | No | Lista de campos separados por comas. La lista se cruza con $fillable del modelo; si está vacía o no es válida, se devuelven todos los campos. |
orderBy | string | No | Campo de ordenamiento, con - como prefijo para indicar orden descendente. Se pueden encadenar varios campos separados por comas. |
where | string | No | Filtro en JSON sobre los campos que el modelo declara como filtrables. Los campos válidos de cada recurso se exponen en la extensión de schema x-ordering-whereable. |
page | integer | No | Número de página, empezando en 1. Solo se aplica a las listas que devuelven un bloque de paginación. |
page_size | integer | No | Cantidad de elementos por página. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Respuesta de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error: el proyecto no existe o no tiene una suscripción activa. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |