API Documentos Contables/Centro Operaciones - Historial de revisiones

Dvaldes: Dvaldes trasladó la página API Documentos-Contables/Centro Operaciones a API Documentos Contables/Centro Operaciones

2023-07-21T14:21:45Z

Dvaldes trasladó la página API Documentos-Contables/Centro Operaciones a API Documentos Contables/Centro Operaciones

← Revisión anterior	Revisión del 09:21 21 jul 2023
(Sin diferencias)

Gpazos en 02:06 5 jun 2023

2023-06-05T02:06:17Z

← Revisión anterior		Revisión del 21:06 4 jun 2023
Línea 1:		Línea 1:
	'''Descripción:'''		'''Descripción:'''
	~~Este reporte entrega una visión completa de~~ la ~~gestión del agente al resumir individualmente la actividad del asesor indicando el total~~ de ~~las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo~~ de ~~Ring, ACW y AHT), fecha~~ y ~~hora de Log In/Log Out, además~~ la ~~cantidad de hits y RPC~~.		Esta API permite la sincronización de los '''Centros de Operaciones''' entre SERPI y la plataforma que lo requiera.

	'''Autorización:'''		'''Autorización:'''
Línea 6:		Línea 6:

	'''Beneficio:'''		'''Beneficio:'''
	~~Este reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)~~

	'''Tipos de peticiones:'''		'''Tipos de peticiones:'''
Línea 12:		Línea 11:

	'''¿Cómo funciona?'''		'''¿Cómo funciona?'''
	*El consumo de esta API se realiza por método GET.
	*Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
	*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.		*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
	*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.		*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Dvaldes: /* Métodos */

2023-06-02T21:33:53Z

Métodos

← Revisión anterior		Revisión del 16:33 2 jun 2023
Línea 90:		Línea 90:
	! Campo !! Tipo de dato !! Descripción		! Campo !! Tipo de dato !! Descripción
	\|-		\|-
	\| id \|\| int \|\| Identificador de ~~la unidad de medida~~		\| id \|\| int \|\| Identificador del centro de operación
	\|-		\|-
	\| abreviatura \|\| string \|\| Abreviatura del centro de operación		\| abreviatura \|\| string \|\| Abreviatura del centro de operación

Dvaldes: /* ¿Cómo consumir la API? */

2023-06-02T21:33:05Z

¿Cómo consumir la API?

← Revisión anterior		Revisión del 16:33 2 jun 2023
Línea 340:		Línea 340:
	RequestBody body = RequestBody.create(mediaType, "");		RequestBody body = RequestBody.create(mediaType, "");
	Request request = new Request.Builder()		Request request = new Request.Builder()
	.url("https://localhost:44305/api/v1/~~UnidadMedida~~")		.url("https://localhost:44305/api/v1/CentroOperacion")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{{secret key}}")		.addHeader("secretkey", "{{secret key}}")
Línea 353:		Línea 353:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	var client = new HttpClient();		var client = new HttpClient();
	var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/~~UnidadMedida~~");		var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/CentroOperacion");
	request.Headers.Add("secretkey", "{{secret key}}");		request.Headers.Add("secretkey", "{{secret key}}");
	request.Headers.Add("Authorization", "Bearer{{token}}");		request.Headers.Add("Authorization", "Bearer{{token}}");
Línea 370:		Línea 370:
	require_once 'HTTP/Request2.php';		require_once 'HTTP/Request2.php';
	$request = new HTTP_Request2();		$request = new HTTP_Request2();
	$request->setUrl('https://localhost:44305/api/v1/~~UnidadMedida~~');		$request->setUrl('https://localhost:44305/api/v1/CentroOperacion');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(

Dvaldes: /* Métodos */

2023-06-02T21:32:46Z

Métodos

← Revisión anterior		Revisión del 16:32 2 jun 2023
Línea 134:		Línea 134:
	{{token}} Token de autorizacion generado por SerpiERP		{{token}} Token de autorizacion generado por SerpiERP
	</syntaxhighlight>		</syntaxhighlight>


	'''Request'''		'''Request'''
Línea 229:		Línea 228:
	{		{
	"id": 1,		"id": 1,
	"~~codigo~~": "1",		"abreviatura": "CO1",
	"descripcion": "~~UNIDAD~~ DEMO",		"descripcion": "CENTRO DE OPERACION DEMO",
	"~~abreviatura~~": "~~Und~~"		"direccion": "CALLE 1 # 2-3",
			"codigo_pais": 1,
			"codigo_departamento": 76,
			"codigo_ciudad": 76001,
			"telefono": 1234567,
			"movil": "1234567890"
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 287:		Línea 291:
	"errors": [		"errors": [
	"El campo id es obligatorio",		"El campo id es obligatorio",
	"~~El codigo 4~~ ya esta asociado ~~a otro~~ id",		"La abreviatura CO1 ya esta asociado al id x",
	"El campo descripcion es obligatorio",		"El campo descripcion es obligatorio",
	"~~La abreviatura Und ya esta asociado a otro id~~"		"El campo direccion es obligatorio",
			"El campo movil es obligatorio",
			"El codigo 1 del campo codigo_pais no existe",
			"El codigo 76 del campo codigo_departamento no existe",
			"El codigo 76001 del campo codigo_ciudad no existe"
	],		],
	"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"		"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"

Dvaldes: /* Métodos */

2023-06-02T21:29:27Z

Métodos

← Revisión anterior		Revisión del 16:29 2 jun 2023
Línea 91:		Línea 91:
	\|-		\|-
	\| id \|\| int \|\| Identificador de la unidad de medida		\| id \|\| int \|\| Identificador de la unidad de medida
	\|-
	~~\| codigo \|\| string \|\| Código único del centro de operación~~
	\|-		\|-
	\| abreviatura \|\| string \|\| Abreviatura del centro de operación		\| abreviatura \|\| string \|\| Abreviatura del centro de operación
Línea 100:		Línea 98:
	\| direccion \|\| string \|\| Dirección del centro de operación		\| direccion \|\| string \|\| Dirección del centro de operación
	\|-		\|-
	\| codigo_pais\|\| ~~string~~ \|\| Código del país		\| codigo_pais\|\| int \|\| Código del país
	\|-		\|-
	\| pais \|\| string \|\| Nombre del país		\| pais \|\| string \|\| Nombre del país
	\|-		\|-
	\| codigo_departamento \|\| ~~string~~ \|\| Código del departamento		\| codigo_departamento \|\| int \|\| Código del departamento
	\|-		\|-
	\| departamento \|\| string \|\| Nombre del departamento		\| departamento \|\| string \|\| Nombre del departamento
	\|-		\|-
	\| codigo_ciudad \|\| ~~string~~ \|\| Código de ciudad		\| codigo_ciudad \|\| int \|\| Código de ciudad
	\|-		\|-
	\| ciudad \|\| string \|\| Nombre de la ciudad		\| ciudad \|\| string \|\| Nombre de la ciudad
	\|-		\|-
	\| telefono \|\| ~~string~~ \|\| Teléfono del centro de operación		\| telefono \|\| int \|\| Teléfono del centro de operación
	\|-		\|-
	\| movil \|\| string \|\| Número de celular del centro de operación		\| movil \|\| string \|\| Número de celular del centro de operación
Línea 158:		Línea 156:
	! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción		! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
	\|-		\|-
	\| ~~codigo~~ \|\| string \|\| 5 \|\| Si \|\| ~~Código único~~ de ~~la unidad~~ de ~~medida. No puede repetirse~~		\| abreviatura \|\| string \|\| 11 \|\| Si \|\| Abreviatura del centro de operación
			\|-
			\| descripcion \|\| string \|\| 11 \|\| Si \|\| Descripción del centro de operación
			\|-
			\| direccion \|\| string \|\| 11 \|\| Si \|\| Dirección del centro de operación
	\|-		\|-
	\| ~~descripcion~~ \|\| ~~string~~ \|\| 50 \|\| Si \|\| ~~Descripción de la unidad de medida~~		\| codigo_pais\|\| int \|\| 11 \|\| Si \|\| Código del país
	\|-		\|-
	\| ~~abreviatura~~ \|\| string \|\| 10 \|\| Si \|\| ~~Abreviatura única~~ de ~~la unidad~~ de ~~medida~~		\| codigo_departamento \|\| int \|\| 11 \|\| Si \|\| Código del departamento
			\|-
			\| codigo_ciudad \|\| int \|\| 11 \|\| Si \|\| Código de ciudad
			\|-
			\| telefono \|\| int \|\| 11 \|\| No \|\| Teléfono del centro de operación
			\|-
			\| movil \|\| string \|\| 11 \|\| Si \|\| Número de celular del centro de operación
	\|}		\|}

	==== '''AVISO IMPORTANTE:''' ====		==== '''AVISO IMPORTANTE:''' ====
	Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.		Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.


	'''Response'''		'''Response'''
Línea 185:		Línea 192:
	"code": 400,		"code": 400,
	"errors": [		"errors": [
	"~~El codigo 1~~ ya existe",		"La abreviatura CO1 ya existe",
	"El campo descripcion es obligatorio",		"El campo descripcion es obligatorio",
	"El campo ~~abreviatura~~ es obligatorio",		"El campo direccion es obligatorio",
	"~~La abreviatura Und ya esta asociado a otro id~~"		"El campo movil es obligatorio",
			"El codigo 1 del campo codigo_pais no existe",
			"El codigo 76 del campo codigo_departamento no existe",
			"El codigo 76001 del campo codigo_ciudad no existe"
	],		],
	"message": "Problemas de validaciones. Se presentaron errores al crear el registro"		"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
Línea 231:		Línea 241:
	! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción		! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
	\|-		\|-
	\| id \|\| int \|\| 11 \|\| Si \|\| Identificador de ~~la unidad de medida~~		\| id \|\| int \|\| 11 \|\| Si \|\| Identificador del centro de operación
	\|-		\|-
	\| ~~codigo~~ \|\| string \|\| 5 \|\| Si \|\| ~~Código único~~ de ~~la unidad de medida. No puede repetirse~~		\| abreviatura \|\| string \|\| 11 \|\| Si \|\| Abreviatura del centro de operación
	\|-		\|-
	\| descripcion \|\| string \|\| 50 \|\| Si \|\| Descripción de ~~la unidad de medida~~		\| descripcion \|\| string \|\| 11 \|\| Si \|\| Descripción del centro de operación
	\|-		\|-
	\| ~~abreviatura~~ \|\| string \|\| 10 \|\| Si \|\| ~~Abreviatura única~~ de ~~la unidad~~ de ~~medida~~		\| direccion \|\| string \|\| 11 \|\| Si \|\| Dirección del centro de operación
			\|-
			\| codigo_pais\|\| int \|\| 11 \|\| Si \|\| Código del país
			\|-
			\| codigo_departamento \|\| int \|\| 11 \|\| Si \|\| Código del departamento
			\|-
			\| codigo_ciudad \|\| int \|\| 11 \|\| Si \|\| Código de ciudad
			\|-
			\| telefono \|\| int \|\| 11 \|\| No \|\| Teléfono del centro de operación
			\|-
			\| movil \|\| string \|\| 11 \|\| Si \|\| Número de celular del centro de operación
	\|}		\|}

	==== '''AVISO IMPORTANTE:''' ====		==== '''AVISO IMPORTANTE:''' ====
	Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.		Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.


	'''Response'''		'''Response'''

Dvaldes: /* Métodos */

2023-06-02T21:18:46Z

Métodos

← Revisión anterior		Revisión del 16:18 2 jun 2023
Línea 23:		Línea 23:

	'''EndPoint:'''		'''EndPoint:'''
	<nowiki>https://www.apis.serpi.com.co/api/v1/~~UnidadMedida~~</nowiki>		<nowiki>https://www.apis.serpi.com.co/api/v1/CentroOperacion</nowiki>

	'''EndPoint con parámetros:'''		'''EndPoint con parámetros:'''
	<nowiki>https://www.apis.serpi.com.co/api/v1/~~UnidadMedida~~?limite=50&pagina=1</nowiki>		<nowiki>https://www.apis.serpi.com.co/api/v1/CentroOperacion?limite=50&pagina=1</nowiki>

	{\| class="wikitable"		{\| class="wikitable"
Línea 62:		Línea 62:
	{		{
	"id": 1,		"id": 1,
	"~~codigo~~": "1",		"abreviatura": "1",
	"descripcion": "~~UNIDAD~~ DEMO",		"descripcion": "CENTRO DE OPERACIONES DEMO",
	"~~abreviatura~~": "~~Und~~"		"direccion": "CALLE 1 # 2-3",
			"codigo_pais": 1,
			"pais": "COLOMBIA",
			"codigo_departamento": 76,
			"departamento": "VALLE DEL CAUCA",
			"codigo_ciudad": 76001,
			"ciudad": "SANTIAGO DE CALI",
			"telefono": 1234567,
			"movil": "1234567890"
	}		}
	]		]
Línea 84:		Línea 92:
	\| id \|\| int \|\| Identificador de la unidad de medida		\| id \|\| int \|\| Identificador de la unidad de medida
	\|-		\|-
	\| codigo \|\| string \|\| Código único de ~~la unidad de medida~~		\| codigo \|\| string \|\| Código único del centro de operación
	\|-		\|-
	\| ~~descripcion~~ \|\| string \|\| ~~Descripción~~ de ~~la unidad de medida~~		\| abreviatura \|\| string \|\| Abreviatura del centro de operación
	\|-		\|-
	\| ~~abreviatura~~ \|\| string \|\| ~~Abreviatura única~~ de la ~~unidad~~ de ~~medida~~		\| descripcion \|\| string \|\| Descripción del centro de operación
			\|-
			\| direccion \|\| string \|\| Dirección del centro de operación
			\|-
			\| codigo_pais\|\| string \|\| Código del país
			\|-
			\| pais \|\| string \|\| Nombre del país
			\|-
			\| codigo_departamento \|\| string \|\| Código del departamento
			\|-
			\| departamento \|\| string \|\| Nombre del departamento
			\|-
			\| codigo_ciudad \|\| string \|\| Código de ciudad
			\|-
			\| ciudad \|\| string \|\| Nombre de la ciudad
			\|-
			\| telefono \|\| string \|\| Teléfono del centro de operación
			\|-
			\| movil \|\| string \|\| Número de celular del centro de operación
	\|}		\|}
	</Tab>		</Tab>
Línea 95:		Línea 121:
	<Tab name = "API Creación (POST) ">		<Tab name = "API Creación (POST) ">
	'''EndPoint:'''		'''EndPoint:'''
	https://www.apis.serpi.com.co/api/v1/~~UnidadMedida~~		https://www.apis.serpi.com.co/api/v1/CentroOperacion

	{\| class="wikitable"		{\| class="wikitable"
Línea 115:		Línea 141:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	"~~codigo~~": "1",		"abreviatura": "CO1",
	"descripcion": "~~UNIDAD~~ DEMO",		"descripcion": "CENTRO DE OPERACION DEMO",
	"~~abreviatura~~": "~~Und~~"		"direccion": "CALLE 1 # 2-3",
			"codigo_pais": 1,
			"codigo_departamento": 76,
			"codigo_ciudad": 76001,
			"telefono": 1234567,
			"movil": "1234567890"
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 167:		Línea 198:
	<Tab name = "API Modificar(PUT) ">		<Tab name = "API Modificar(PUT) ">
	'''EndPoint:'''		'''EndPoint:'''
	https://www.apis.serpi.com.co/api/v1/~~UnidadMedida~~		https://www.apis.serpi.com.co/api/v1/CentroOperacion

	{\| class="wikitable"		{\| class="wikitable"

Dvaldes: Página creada con «'''Descripción:''' Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de…»

2023-06-02T21:10:29Z

Página creada con «'''Descripción:''' Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC. '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de…»

Página nueva

'''Descripción:'''
Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta (GET) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/UnidadMedida</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/UnidadMedida?limite=50&pagina=1</nowiki>

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight >
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"codigo": "1",
"descripcion": "UNIDAD DEMO",
"abreviatura": "Und"
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Identificador de la unidad de medida
|-
| codigo || string || Código único de la unidad de medida
|-
| descripcion || string || Descripción de la unidad de medida
|-
| abreviatura || string || Abreviatura única de la unidad de medida
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/UnidadMedida

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"codigo": "1",
"descripcion": "UNIDAD DEMO",
"abreviatura": "Und"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| codigo || string || 5 || Si || Código único de la unidad de medida. No puede repetirse
|-
| descripcion || string || 50 || Si || Descripción de la unidad de medida
|-
| abreviatura || string || 10 || Si || Abreviatura única de la unidad de medida
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El codigo 1 ya existe",
"El campo descripcion es obligatorio",
"El campo abreviatura es obligatorio",
"La abreviatura Und ya esta asociado a otro id"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/UnidadMedida

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1,
"codigo": "1",
"descripcion": "UNIDAD DEMO",
"abreviatura": "Und"
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Identificador de la unidad de medida
|-
| codigo || string || 5 || Si || Código único de la unidad de medida. No puede repetirse
|-
| descripcion || string || 50 || Si || Descripción de la unidad de medida
|-
| abreviatura || string || 10 || Si || Abreviatura única de la unidad de medida
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El codigo 4 ya esta asociado a otro id",
"El campo descripcion es obligatorio",
"La abreviatura Und ya esta asociado a otro id"
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/UnidadMedida")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/UnidadMedida");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/UnidadMedida');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]