API Países

Esta API permite gestionar los países utilizados en la empresa, incluyendo su asignación a contactos y su relación con departamentos.

La funcionalidad corresponde a Configuración > Países y Departamentos.

Casos de uso

  • Consultar países registrados.
  • Crear o actualizar países.
  • Obtener un país específico.
  • Eliminar registros sin uso.

Endpoint del servicio

Método Query

Permite obtener un listado de países.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
CodigoDesde T(3) No Código inicial del rango.
CodigoHasta T(3) No Código final del rango.
NombreContiene T(20) No Búsqueda parcial por nombre.
Page N(2) Paginación (500 registros por página).

Estructura del response

Codigo
Nombre
CodigoISO

Método Save

Permite crear o actualizar un país.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
Codigo T(3) Identificador único del país.
Nombre T(40) Nombre del país.
CodigoISO T(2) Código ISO 3166-1 alfa-2.

Resultado

Succeed / Error / Mensaje

Método Load

Permite obtener un país específico.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
Codigo T(3) Identificador único del país.

Resultado

Codigo
Nombre
CodigoISO

Método Delete

Permite eliminar un país.

Parámetros de entrada

Parámetro Tipo Obligatorio Descripción
Codigo T(3) Identificador único del país.

Resultado

Succeed / Error / Mensaje

Consideraciones

  • Los países son utilizados en la asignación de contactos y departamentos.
  • Se recomienda validar la existencia antes de crear o actualizar registros.
Importante: No es posible eliminar un país si está asociado a contactos o departamentos existentes.
Compartir

API Países

O copia el enlace

CONTENIDO