Obtiene la lista de cargos existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/cargos/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
MostrarInactivos | Booleano | Indica si quiere traer registros con estado inactivo. se debe indicar con true o false. | No. |
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,500] Exito,Error. |
Message | "Message":"Lista de cargos obtenida exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con el listado de Cargos registradas en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Lista de cargos obtenida exitosamente.", "Entity": "[{\"IdCargo\":1,\"NomCargo\":\"Ninguno\",\"Nivel\":\"Principal\",\"Sigla\":\"NA\",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":2,\"NomCargo\":\"ALBERTO.PALENCIA@ISOLUCION.COM.CO\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":3,\"NomCargo\":\"COORDINADOR,05/29/2014\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":0,\"Sucursales\":"1"},{\"IdCargo\":4,\"NomCargo\":\"COORDINADOR\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":5,\"NomCargo\":\"caergo fun\",\"Nivel\":\"Principal\",\"Sigla\":\"cfun\",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":6,\"NomCargo\":\"LA DORADA\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":7,\"NomCargo\":\"MEDELLIN\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":8,\"NomCargo\":\"MECANICO\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":0,\"Sucursales\":1},{\"IdCargo\":9,\"NomCargo\":\"TERMINADOR\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":10,\"NomCargo\":\"DEVELOPER\",\"Nivel\":\"Staff\",\"Sigla\":\"\",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":11,\"NomCargo\":\"DEV\",\"Nivel\":\"Staff\",\"Sigla\":\"\",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":12,\"NomCargo\":\"DEVelop\",\"Nivel\":\"Staff\",\"Sigla\":\"\",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":13,\"NomCargo\":\"DEVelop0003\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":14,\"NomCargo\":\"sample string 11\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":15,\"NomCargo\":\"DEVelop0004\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":16,\"NomCargo\":\"DEVelop00041\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":17,\"NomCargo\":\"DEVelop00042\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":18,\"NomCargo\":\"DEVelop00043\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":19,\"NomCargo\":\"DEVelop00044\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":20,\"NomCargo\":\"DEVelop0001\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":21,\"NomCargo\":\"DEVelop0002\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1},{\"IdCargo\":22,\"NomCargo\":\"OTRO CARg\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":23,\"NomCargo\":\"CHIEF Security Officer\",\"Nivel\":\"Staff\",\"Sigla\":\"CSO\",\"Activo\":0,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":24,\"NomCargo\":\"ACCOUNT MANAGER\",\"Nivel\":\"Staff\",\"Sigla\":\"AM\",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":25,\"NomCargo\":\"SENIOR DEVELOPER\",\"Nivel\":\"Staff\",\"Sigla\":\"SD\",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":26,\"NomCargo\":\"JUNIOR DEVELOPER\",\"Nivel\":\"Staff\",\"Sigla\":\"SENDEV\",\"Activo\":0,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":27,\"NomCargo\":\"Cargo QA 29\",\"Nivel\":\"Staff\",\"Sigla\":\"ca1\",\"Activo\":0,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":28,\"NomCargo\":\"Cargo QA1\",\"Nivel\":\"Staff\",\"Sigla\":\"ca1\",\"Activo\":0,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":29,\"NomCargo\":\"sample string 13\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null},{\"IdCargo\":30,\"NomCargo\":\"Administrador\",\"Nivel\":\"Staff\",\"Sigla\":\" \",\"Activo\":1,"EsNivelGlobal\":1,\"Sucursales\":null}]" }
Sample ERROR Response:
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Crea un cargo en el sistema ISOLUCIÓN a través de esta opción.
HTTP POST: https://[service_address]/api/cargos/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
NomCargo | Texto | varchar(200) | Nombre del cargo. | Si. |
Nivel | Texto | varchar(100) | Nivel del cargo. Lista de valores, si no existe se crea con el valor enviado. | Si. |
Sigla | Texto | varchar(15) | Sigla del cargo. | Si. |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el cargo se encuentra activo o no. | Si. | |
EsNivelGlobal | Entero | int | Indica si el cliente es de nivel global (1) o pertenece a alguna sucursal (0) | Si (Para empresas con multicompañia) |
Sucursales | Texto | varchar(255) | Lista de sucursales a las que pertenece el cliente | Si (Para empresas con multicompañia) |
Sample:
{"NomCargo":"JUNIOR DEVELOPER","Sigla":"JD","Activo":"1","Nivel":"Staff","EsNivelGlobal\":1,\"Sucursales\":null}
Respuesta en Formato JSON a la solicitud de creación en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,500] Exito,Error. |
Message | "Message":" El Cargo ha sido creado exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con los datos creados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": " El Cargo ha sido creado exitosamente.", "Entity": "{\"NomCargo\":\"JUNIOR DEVELOPER\",\"Nivel\":\"Staff\",\"Sigla\":\"JD\",\"Activo\":1}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Actualiza un cargo en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/cargos/ActualizarXNombre
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
NomCargo | Texto | varchar(200) | Nombre del cargo. Debe existir previamente. No puede modificarse. | Si. |
Nivel | Texto | varchar(100) | Nivel del cargo. Lista de valores, si no existe se crea con el valor enviado. | Si. |
Sigla | Texto | varchar(15) | Sigla del cargo. | Si. |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el cargo se encuentra activo o no. | Si. | |
EsNivelGlobal | Entero | int | Indica si el cliente es de nivel global (1) o pertenece a alguna sucursal (0) | Si (Para empresas con multicompañia) |
Sucursales | Texto | varchar(255) | Lista de sucursales a las que pertenece el cliente | Si (Para empresas con multicompañia) |
Sample:
{"NomCargo":"JUNIOR DEVELOPER","Sigla":"SENDEV","Activo":"1","Nivel":"Staff","EsNivelGlobal":"1","Sucursales":"3"}
Respuesta en Formato JSON a la solicitud de actualización en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error. |
Message | "Message":" El Cargo ha sido actualizado exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con los datos actualizados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "El Cargo ha sido actualizado exitosamente.", "Entity": "{\"NomCargo\":\"JUNIOR DEVELOPER\",\"Nivel\":\"Staff\",\"Sigla\":\"SENDEV\",\"Activo\":1}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 404, "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Actualiza un cargo en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/cargos/ActualizarXSigla
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
NomCargo | Texto | varchar(200) | Nombre del cargo. Debe existir previamente. | Si. |
Nivel | Texto | varchar(100) | Nivel del cargo. Lista de valores, si no existe se crea con el valor enviado. | Si. |
Sigla | Texto | varchar(15) | Sigla del cargo. No puede modificarse. | Si. |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el cargo se encuentra activo o no. | Si. | |
EsNivelGlobal | Entero | int | Indica si el cliente es de nivel global (1) o pertenece a alguna sucursal (0) | Si (Para empresas con multicompañia) |
Sucursales | Texto | varchar(255) | Lista de sucursales a las que pertenece el cliente | Si (Para empresas con multicompañia) |
Sample:
{"NomCargo":"JUNIOR DEVELOPER","Sigla":"SENDEV","Activo":"1","Nivel":"Staff","EsNivelGlobal":"1","Sucursales":"3"}
Respuesta en Formato JSON a la solicitud de actualización en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error. |
Message | "Message":" El Cargo ha sido actualizado exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con los datos actualizados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "El Cargo ha sido actualizado exitosamente.", "Entity": "{\"NomCargo\":\"JUNIOR DEVELOPER\",\"Nivel\":\"Staff\",\"Sigla\":\"SENDEV\",\"Activo\":1}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 404, "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }