Consultar la versión de una API de VPCEP especificada
Función
Función Esta API se utiliza para consultar la versión de una API de VPCEP especificada.
URI
GET /{version}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
version |
Sí |
String |
Especifica el número de versión que se va a consultar. El valor comienza con v, por ejemplo, v1. Si este parámetro se deja en blanco, se consultan las versiones de todas las API de VPCEP. |
Parámetros de Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
Content-Type |
Sí |
String |
Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda el valor predeterminado application/json. Para las API utilizadas para cargar objetos o imágenes, el tipo MIME varía según el tipo de flujo. |
Parámetros de Respuesta
Status code: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
version |
VersionObject object |
Especifica las versiones de la API de VPCEP. |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Especifica el estado de la versión. ● ACTUAL: indica una versión principal. ● SOPORTE: indica una versión anterior que todavía es compatible. ● DEPRECADO: indica la versión obsoleta que puede eliminarse más tarde. |
id |
String |
Especifica el ID de versión de la API. |
updated |
String |
Especifica la hora en que se publicó la versión de la API. El formato de hora UTC aplicado es AAAA-MMDDTHH:MM:SSZ. |
version |
String |
Especifica el número de versión admitido. |
min_version |
String |
Especifica el número de microversión admitido. Si las API no admiten microversiones, el parámetro se deja en blanco. |
links |
Array of Link objects |
Especifica la URL de la API. |
Parámetro |
Tipo |
Descripción |
---|---|---|
href |
String |
Especifica la dirección de referencia de la versión actual de la API. |
type |
String |
Especifica el tipo MIME del cuerpo de la solicitud. El valor es application/json. |
rel |
String |
Especifica la relación entre la versión actual de la API y la dirección a la que se hace referencia. |
Status code: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 405
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 406
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 407
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 408
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 409
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 501
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 502
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 503
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 504
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Solicitudes de Ejemplo
GET https://{endpoint}/v1
Respuestas de Ejemplo
Status code: 200
El servidor ha procesado correctamente la solicitud.
{ "version":{ { "updated":"2018-09-30T00:00:00Z", "version":"1", "min_version":"", "status":"CURRENT", "id":"v1", "links":[ { "href":"https://{vpcep_uri}/v1", "type":"application/json", "rel":"self" } ] } } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
El servidor ha procesado correctamente la solicitud. |
400 |
El servidor no pudo entender la solicitud debido a una sintaxis mal formada. |
401 |
La página solicitada requiere un nombre de usuario y contraseña. |
403 |
El servidor entendió la solicitud, pero se niega a cumplirla. |
404 |
La página solicitada no se ha podido encontrar. |
405 |
El método especificado en la línea de solicitud no está permitido para el recurso identificado por el URI de solicitud. |
406 |
El recurso identificado por la solicitud sólo es capaz de generar entidades de respuesta que tienen características de contenido no aceptables de acuerdo con las cabeceras de aceptación enviadas en la solicitud. |
407 |
El cliente primero debe autenticarse con el proxy. |
408 |
El cliente no produjo una solicitud dentro del tiempo que el servidor estaba preparado para esperar. |
409 |
No se pudo completar la solicitud debido a un conflicto con el estado actual del recurso. |
500 |
Error al completar la solicitud. Anormalidad del servicio. |
501 |
Error al completar la solicitud. El servidor no admite la función solicitada. |
502 |
Error al completar la solicitud. porque el servidor ha recibido una respuesta no válida. |
503 |
Error al completar la solicitud. porque el sistema no está disponible. |
504 |
Fin del tiempo de espera del gateway |
Códigos de error
Consulte Códigos de error.