Consulta de versiones de API
Función
Esta API se utiliza para consultar todas las versiones de API disponibles del servicio de BMS.
URI
GET /
Respuesta
- Parámetros de respuesta
Parámetro
Tipo
Descripción
versions
Array of objects
Especifica las versiones de API del servicio de BMS. Para obtener más información, véase Tabla 1.
Tabla 1 Descripción de la estructura de datos de campo versions Parámetro
Tipo
Descripción
id
String
Especifica el ID de versión de la API.
links
Array of objects
Especifica la URL de la API. Para obtener más información, véase Tabla 2.
min_version
String
Especifica la versión más antigua de la micro API que se admite.
status
String
Especifica el estado de la versión de la API.
- CURRENT: indica una versión principal.
- SUPPORTED: indica una versión anterior que todavía es compatible.
- DEPRECATED: indica una versión obsoleta que puede eliminarse más tarde.
updated
String
Especifica la fecha de lanzamiento de una versión de API.
El formato de marca de tiempo es AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por ejemplo, 2018-09-30T00:00:00Z.
version
String
Especifica la versión más reciente de la micro API que se admite.
Tabla 2 Descripción de la estructura de datos de campo links Parámetro
Tipo
Descripción
href
String
Especifica el URL de la API.
rel
String
Especifica la dependencia URL de la API. El valor puede ser:
- self: el enlace de recurso que contiene el número de la versión. Se utiliza cuando se requiere un seguimiento inmediato.
- bookmark: el enlace de recurso que se puede almacenar durante mucho tiempo.
- Ejemplo de la respuesta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
{ "versions": [ { "id": "v1", "links": [ { "href": "http://bms.xxx.com/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2018-09-30T00:00:00Z", "version": "" } ] }
Valores devueltos
Valores devueltos |
Descripción |
---|---|
200 |
La solicitud se ha procesado correctamente. |
Para obtener más información sobre otros valores devueltos, consulte Códigos de estado.
Códigos de error
Véase Códigos de error.