Está en la página 1de 28

Servicio Web del sistema

Keito eHealth

Servicio Web del sistema Keito e-Health Página 1 de 28


Ver 4.12.1a
Contenido
1 INTRODUCCIÓN ........................................................................................ 3

2 CONEXIÓN ................................................................................................. 3

3 TRATAMIENTO DE ERRORES ................................................................. 3

4 OPERACIONES .......................................................................................... 4

4.1 AppCreateUserWithCardCode................................................................................................... 4

4.2 AppGetAdminOrganizations ...................................................................................................... 5

4.3 AppGetOrgUsers .......................................................................................................................... 6

4.4 AppGetOrgUsersEx ..................................................................................................................... 8

4.5 AppGetOrgUsersMeasurements ............................................................................................... 10

4.6 AppGetOrgUsersMeasurementsEx .......................................................................................... 12

4.7 AppGetUserIDFromCardCode................................................................................................. 14

4.8 AppGetUserInfo ......................................................................................................................... 15

4.9 AppGetUserInfoEx .................................................................................................................... 17

4.10 AppGetUserMeasurements ....................................................................................................... 18

4.11 AppGetUserMeasurementsEx................................................................................................... 20

4.12 AppRegisterUserToOrg ............................................................................................................. 21

4.13 AppUnregisterUserFromOrg .................................................................................................... 22

4.14 AppUpdateUserBirthDateAndSex ............................................................................................ 23

4.15 AppUpdateUserOrganizationClientCode ................................................................................ 24

4.16 AppUpdateUserOrganizationCredit ........................................................................................ 25

4.17 AppUpdateUserOrganizationCreditEx .................................................................................... 26

4.18 AppVerifyFingerprintMatch..................................................................................................... 27

4.19 ExecuteCmdK6........................................................................................................................... 27

4.20 GetVersion .................................................................................................................................. 27

5 APÉNDICE A. VALORES ENUMERADOS .............................................. 28

5.1 Enumerado eCardTypes ............................................................................................................ 28

5.2 Enumerado eSex ......................................................................................................................... 28

Servicio Web del sistema Keito e-Health Página 2 de 28


Ver 4.12.1a
1 Introducción
El presente documento especifica las operaciones o funciones disponibles en el servicio
web del sistema Keito Vital System.
Las llamadas a estas operaciones o funciones deben seguir el protocolo SOAP 1.1 o
SOAP 1.2.

2 Conexión
La dirección URL del servicio web es la siguiente
http://www.keitovs.net/keitows/fingerprint.asmx

Introduciendo esta URL en un navegador web, se muestra una página de ayuda en la


que se describen todas las operaciones disponibles. Por cada operación se ofrece una
página de prueba en la que además se describe el formato de la llamada y de los datos
de entrada y salida.

La descripción del servicio WSDL puede descargarse de la dirección


http://www.keitovs.net/keitows/fingerprint.asmx?wsdl

3 Tratamiento de errores
Si el resultado de la llamada no produce ningún error, el campo nErrorCode valdrá
resErrNoError, y se devolverá los datos solicitados.
En el caso de que se produzca un error, el campo nErrorCode devolverá uno de los
valores alternativos (tabla) y los campos sErrorDescription, sErrorSource y
sStackTrace proporcionarán detalles del error.

Código de error Descripción


resErrNoError No se produjo ningún error
resErrErrorDB Error en la base de datos
resErrInvalidParameter Parámetro incorrecto
resErrUnexpectedError Error inesperado
resErrInvalidLogin Error en el login / identificación
resErrNoOrganizationAssigned No tiene asignada ninguna organización
resErrNotAutorized No autorizado
resErrUserNotBelongsToOrg El usuario no pertenece a la organización
resErrUserAlreadyBelongsToOrg El usuario ya pertenece a la organización
resCannotUpdate No fue posible actualizar datos
resErrNotFound No se encontró el registro
resErrAlreadyExists El usuario u organización ya existe.

Servicio Web del sistema Keito e-Health Página 3 de 28


Ver 4.12.1a
4 Operaciones
4.1 AppCreateUserWithCardCode
Esta función crea un nuevo usuario al cual se le asigna un código de tarjeta y lo asocia a
una organización.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización a la que se
asociará el nuevo usuario.
eCardType Enumerado Tipo de código de barras o de tarjeta magnética.
eCardTypes En el apéndice A se describen los valores
posibles.
sCardCode cadena Código de tarjeta del nuevo usuario.
dBirthDate Fecha Fecha de nacimiento del nuevo usuario.
eSex Enumerado Sexo del usuario. En el apéndice A se describen
eSex los valores posibles.

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:
<AppCreateUserWithCardCodeResult>
<nErrorCode>resErrNoError or resErrErrorDB
or resErrInvalidParameter or resErrUnexpectedError
or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or
resErrUserAlreadyBelongsToOrg or resCannotUpdate or
resErrNotFound or resErrAlreadyExists
</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</AppCreateUserWithCardCodeResult>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y


nReturnValue devuelve el identificador (UserID) del nuevo usuario.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 4 de 28


Ver 4.12.1a
4.2 AppGetAdminOrganizations
Devuelve la lista de organizaciones que el usuario está autorizado a administrar.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:
<AppGetAdminOrganizationsResult>
<Result>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</Result>

<Organizations>
<COrganization>
<nID>int</nID>
<sDescripcio>string</sDescripcio>
</COrganization>
...
<COrganization>
<nID>int</nID>
<sDescripcio>string</sDescripcio>
</COrganization>
</Organizations>
</AppGetAdminOrganizationsResult>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve la lista de organizaciones que el usuario puede administrar. Por cada
organización se devuelve el Código de Organización (nID) y el nombre de la misma
(sDescripcio).

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 5 de 28


Ver 4.12.1a
4.3 AppGetOrgUsers
Devuelve la lista de usuarios registrados en una organización.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:
<AppGetOrgUsersResult>
<Result>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</Result>
<Users>
<CUser>
<nUserID>int</nUserID>
<sName>string</sName>
<sLastName1>string</sLastName1>
<sLastName2>string</sLastName2>
<dBirthDate>dateTime</dBirthDate>
<dStartDate>dateTime</dStartDate>
<sAddress>string</sAddress>
<sCity>string</sCity>
<sPostalCode>string</sPostalCode>
<Sex>sexMale or sexFemale or sexNull</Sex>
<nIDOrg>int</nIDOrg>
<nCredit>int</nCredit>
<sClientCode>string</sClientCode>
<sTextFIR>string</sTextFIR>
<bEmpleadoKeito>boolean</bEmpleadoKeito>
<sErrorSource>string</sErrorSource>
<sErrorDescription>string</sErrorDescription>
<sErrorStackTrace>string</sErrorStackTrace>
<CLastMeasures xsi:nil="true" />
</CUser>
...
<CUser>
</CUser>
</Users>
</AppGetOrgUsersResult>

Servicio Web del sistema Keito e-Health Página 6 de 28


Ver 4.12.1a
Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se
devuelve la lista de usuarios que están asociados a la organización. La lista consiste en
una lista de objetos CUser cuya estructura se detalla a continuación.

Nombre Tipo Descripción


nUserID entero Identificador de usuario
dBirthDate Fecha Fecha de nacimiento
dStartDate Fecha Fecha de alta en la organización
Sex Enumerado Sexo. Véase el apéndice A.
eSex
nCredit entero Crédito disponible para la organización
sClientCode cadena Código de cliente
Los demás campos se devuelven vacíos.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 7 de 28


Ver 4.12.1a
4.4 AppGetOrgUsersEx
Devuelve la lista de usuarios registrados en una organización. Esta función ofrece la
misma funcionalidad que AppGetOrgUsers, con el añadido que la respuesta incluye
además el campo asCardCodes que es una lista de códigos de tarjeta magnética o de
código de barras.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:
<AppGetOrgUsersExResult>
<Result>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate or resErrNotFound or resErrAlreadyExists</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</Result>
<Users>
<CUserEx>
<CLastMeasures xsi:nil="true" />
<nUserID>int</nUserID>
<sName>string</sName>
<sLastName1>string</sLastName1>
<sLastName2>string</sLastName2>
<dBirthDate>dateTime</dBirthDate>
<dStartDate>dateTime</dStartDate>
<sAddress>string</sAddress>
<sCity>string</sCity>
<sPostalCode>string</sPostalCode>
<Sex>sexMale or sexFemale or sexNull</Sex>
<nIDOrg>int</nIDOrg>
<nCredit>int</nCredit>
<sClientCode>string</sClientCode>
<sTextFIR>string</sTextFIR>
<bEmpleadoKeito>boolean</bEmpleadoKeito>
<asCardCodes xsi:nil="true" />
</CUserEx>
<CUserEx>
...
</CUserEx>
</Users>
</AppGetOrgUsersExResult>

Servicio Web del sistema Keito e-Health Página 8 de 28


Ver 4.12.1a
Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se
devuelve la lista de usuarios que están asociados a la organización. La respuesta
consiste en una lista de objetos CUserEx cuya estructura se detalla a continuación.

Nombre Tipo Descripción


nUserID entero Identificador de usuario
dBirthDate Fecha Fecha de nacimiento
dStartDate Fecha Fecha de alta en la organización
Sex Enumerado Sexo . Véase el apéndice A.
eSex
nCredit entero Crédito disponible para la organización
sClientCode cadena Código de cliente
asCardCodes Lista de Lista de códigos de tarjeta magnética o de código
cadenas de barras.
Los demás campos se devuelven vacíos.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 9 de 28


Ver 4.12.1a
4.5 AppGetOrgUsersMeasurements
Devuelve la lista de usuarios registrados en una organización. Por cada usuario
devuelve las medidas realizadas entre dos fechas.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nMaxNumberOfMeasures entero Número máximo de medidas por usuario.
dStartDateTime Fecha/hora Fecha inicial
dEndDateTime Fecha/hora Fecha final

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:
<AppGetOrgUsersMeasurementsResponse xmlns="http://keito.com/webservices/">
<AppGetOrgUsersMeasurementsResult>
<Result>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg
or resCannotUpdate or resErrNotFound or resErrAlreadyExists</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</Result>
<UsersMeasures>
<CUserMeasures>
<UserInfo xsi:nil="true" />
<Measures xsi:nil="true" />
</CUserMeasures>
<CUserMeasures>
<UserInfo xsi:nil="true" />
<Measures xsi:nil="true" />
</CUserMeasures>
</UsersMeasures>
</AppGetOrgUsersMeasurementsResult>
</AppGetOrgUsersMeasurementsResponse>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve la lista de usuarios que están asociados a la organización. Por cada usuario se
devuelve un objeto UserInfo que contiene los campos siguientes:

Nombre Tipo Descripción


nUserID entero Identificador de usuario
dBirthDate Fecha Fecha de nacimiento
Sex Enumerado Sexo . Véase el apéndice A.
eSex
nCredit entero Crédito disponible para la organización
sClientCode cadena Código de cliente
dOrgStartDate Fecha Fecha de alta en la organización

Servicio Web del sistema Keito e-Health Página 10 de 28


Ver 4.12.1a
Por cada medida se devuelve un objeto CMeasure que contiene los campos siguientes:

Nombre Tipo Descripción


nMachineSerial entero Número de serie del equipo Keito donde se
realizó la medida
sMachineModel cadena Modelo del equipo Keito donde se realizó la
medida
dMeasureDate Fecha/hora Fecha y hora de la medida
sngWeight real Peso en Kg.
nHeight entero Estatura en cm.
nMaxBloodPressure entero Tensión arterial máxima en mmHg.
nMinBloodPressure entero Tensión arterial mínima en mmHg.
nPulse entero Pulsaciones por minuto
sngIGP real Índice de grasa

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Nota: No se devuelve información de los usuarios que no tienen medidas en el intervalo


indicado.

Servicio Web del sistema Keito e-Health Página 11 de 28


Ver 4.12.1a
4.6 AppGetOrgUsersMeasurementsEx
Devuelve la lista de usuarios registrados en una organización. Por cada usuario
devuelve las medidas realizadas entre dos fechas. Esta función ofrece la misma
funcionalidad que AppGetOrgUsersMeasurements, con el añadido que la respuesta
incluye además el campo asCardCodes que es una lista de códigos de tarjeta magnética
o de código de barras.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nMaxNumberOfMeasures entero Número máximo de medidas por usuario.
dStartDateTime Fecha/hora Fecha inicial
dEndDateTime Fecha/hora Fecha final

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppGetOrgUsersMeasurementsExResponse xmlns="http://keito.com/webservices/">
<AppGetOrgUsersMeasurementsExResult>
<Result>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate or resErrNotFound or resErrAlreadyExists</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</Result>
<UsersMeasures>
<CUserMeasuresEx>
<UserInfoEx xsi:nil="true" />
<Measures xsi:nil="true" />
</CUserMeasuresEx>
<CUserMeasuresEx>
...
</CUserMeasuresEx>
</UsersMeasures>
</AppGetOrgUsersMeasurementsExResult>
</AppGetOrgUsersMeasurementsExResponse>

Servicio Web del sistema Keito e-Health Página 12 de 28


Ver 4.12.1a
Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se
devuelve la lista de usuarios que están asociados a la organización. Por cada usuario se
devuelve un objeto UserInfoEx que contiene los campos siguientes:

Nombre Tipo Descripción


nUserID entero Identificador de usuario
dBirthDate Fecha Fecha de nacimiento
Sex Enumerado Sexo
eSex
nCredit entero Crédito disponible para la organización
sClientCode cadena Código de cliente
dOrgStartDate Fecha Fecha de alta en la organización
asCardCodes matriz Lista de tarjetas magnéticas del usuario

Por cada medida se devuelve un objeto CMeasure que contiene los campos siguientes:

Nombre Tipo Descripción


nMachineSerial entero Número de serie del equipo Keito donde se
realizó la medida
sMachineModel cadena Modelo del equipo Keito dónde se realizó la
medida
dMeasureDate Fecha/hora Fecha y hora de la medida
sngWeight real Peso en Kg
nHeight entero Estatura en cm.
nMaxBloodPressure entero Tensión arterial máxima en mmHg.
nMinBloodPressure entero Tensión arterial mínima en mmHg.
nPulse entero Pulsaciones por minuto
sngIGP real Índice de grasa

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Nota: No se devuelve información de los usuarios que no tienen medidas en el intervalo


indicado.

Servicio Web del sistema Keito e-Health Página 13 de 28


Ver 4.12.1a
4.7 AppGetUserIDFromCardCode
Devuelve el identificador de usuario a partir de un código de tarjeta magnética o de
código de barras.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización a la que se
asociará el nuevo usuario.
eCardType Enumerado Tipo de código de barras o de tarjeta magnética.
eCardTypes En el apéndice A se describen los valores
posibles.
sCardCode cadena Código de tarjeta del nuevo usuario.

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppGetUserIDFromCardCodeResponse xmlns="http://keito.com/webservices/">
<AppGetUserIDFromCardCodeResult>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate or resErrNotFound or resErrAlreadyExists</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</AppGetUserIDFromCardCodeResult>
</AppGetUserIDFromCardCodeResponse>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve el código de usuario en la variable nReturnValue .

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 14 de 28


Ver 4.12.1a
4.8 AppGetUserInfo
Devuelve información de un usuario registrado en la organización.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nUserID entero Identificador del usuario

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppGetUserInfoResponse xmlns="http://keito.com/webservices/">
<AppGetUserInfoResult>
<Result>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg
or resCannotUpdate or resErrNotFound or resErrAlreadyExists</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</Result>
<Users>
<CUser>
<nUserID>int</nUserID>
<sName>string</sName>
<sLastName1>string</sLastName1>
<sLastName2>string</sLastName2>
<dBirthDate>dateTime</dBirthDate>
<dStartDate>dateTime</dStartDate>
<sAddress>string</sAddress>
<sCity>string</sCity>
<sPostalCode>string</sPostalCode>
<Sex>sexMale or sexFemale or sexNull</Sex>
<nIDOrg>int</nIDOrg>
<nCredit>int</nCredit>
<sClientCode>string</sClientCode>
<sTextFIR>string</sTextFIR>
<bEmpleadoKeito>boolean</bEmpleadoKeito>
<sErrorSource>string</sErrorSource>
<sErrorDescription>string</sErrorDescription>
<sErrorStackTrace>string</sErrorStackTrace>
<CLastMeasures xsi:nil="true" />
</CUser>
<CUser>
...
</CUser>
</Users>
</AppGetUserInfoResult>
</AppGetUserInfoResponse>

Servicio Web del sistema Keito e-Health Página 15 de 28


Ver 4.12.1a
Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se
devuelve una lista de objetos CUser con los datos siguientes:

Nombre Tipo Descripción


nUserID entero Identificador de usuario
dBirthDate Fecha Fecha de nacimiento
dStartDate Fecha Fecha de alta en la organización. En caso que
dicha fecha sea nula, se devuelve la fecha de alta
en el sistema.
Sex Enumerado Sexo. Véase el Apéndice A.
eSex
nIDOrg entero Identificador de la organización
nCredit entero Crédito disponible para la organización
sClientCode cadena Código de cliente
Los demás campos se devuelven vacíos.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 16 de 28


Ver 4.12.1a
4.9 AppGetUserInfoEx
Devuelve información de un usuario registrado en la organización. Esta función ofrece
la misma funcionalidad que AppGetUserInfo, pero se utiliza un código de tarjeta
magnética o de código de barras en lugar del identificador de usuario.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización a la que se
asociará el nuevo usuario.
eCardType Enumerado Tipo de código de barras o de tarjeta magnética.
eCardTypes En el apéndice A se describen los valores
posibles.
sCardCode cadena Código de tarjeta del nuevo usuario.

Devuelve
El valor devuelto consiste en un tipo complejo xml idéntico al descrito en la función
AppGetUserInfo.

Servicio Web del sistema Keito e-Health Página 17 de 28


Ver 4.12.1a
4.10 AppGetUserMeasurements
Devuelve medidas de un usuario. El usuario debe pertenecer a la organización.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nUserID entero Identificador del usuario
nNumberOfMeasures Entero Número máximo de medidas a devolver

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppGetUserMeasurementsResponse xmlns="http://keito.com/webservices/">
<AppGetUserMeasurementsResult>
<Result>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</Result>
<Measures>
<CMeasure>
<nMachineSerial>int</nMachineSerial>
<sMachineModel>string</sMachineModel>
<dMeasureDate>dateTime</dMeasureDate>
<sngWeight>float</sngWeight>
<nHeight>int</nHeight>
<nMaxBloodPressure>int</nMaxBloodPressure>
<nMinBloodPressure>int</nMinBloodPressure>
<nPulse>int</nPulse>
<sngIGP>float</sngIGP>
</CMeasure>
<CMeasure>
...
</CMeasure>
</Measures>
</AppGetUserMeasurementsResult>
</AppGetUserMeasurementsResponse>

Servicio Web del sistema Keito e-Health Página 18 de 28


Ver 4.12.1a
Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se
devuelve una lista de objetos CMeasure que contienen los campos siguientes:

Nombre Tipo Descripción


nMachineSerial entero Número de serie del equipo Keito donde se
realizó la medida
sMachineModel cadena Modelo del equipo Keito dónde se realizó la
medida
dMeasureDate Fecha/hora Fecha y hora de la medida
sngWeight real Peso en Kg
nHeight entero Estatura en cm.
nMaxBloodPressure entero Tensión arterial máxima en mmHg.
nMinBloodPressure entero Tensión arterial mínima en mmHg.
nPulse entero Pulsaciones por minuto
sngIGP real Índice de grasa

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 19 de 28


Ver 4.12.1a
4.11 AppGetUserMeasurementsEx
Devuelve medidas de un usuario perteneciente a una organización. Esta función ofrece
la misma funcionalidad que AppGetUserMeasurements pero se utiliza un código de
tarjeta magnética o de código de barras en lugar del identificador de usuario.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
eCardType Enumerado Tipo de código de barras o de tarjeta
eCardTypes magnética. En el apéndice A se describen los
valores posibles.
sCardCode cadena Código de tarjeta del nuevo usuario.
nNumberOfMeasures Entero Número máximo de medidas a devolver

Devuelve
El valor devuelto consiste en un tipo complejo xml idéntico al descrito en la función
AppGetUserMeasurements.

Servicio Web del sistema Keito e-Health Página 20 de 28


Ver 4.12.1a
4.12 AppRegisterUserToOrg
Registra un usuario en una organización y establece un crédito inicial de medidas en
equipos Keito.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nUserID entero Identificador del usuario
nInitialCredit entero Crédito inicial. Número de medidas permitidas para
el usuario.
sClientCode cadena Código de cliente asociado a la organización.

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:
<AppRegisterUserToOrgResponse xmlns="http://keito.com/webservices/">
<AppRegisterUserToOrgResult>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</AppRegisterUserToOrgResult>
</AppRegisterUserToOrgResponse>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve nReturnValue=0.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 21 de 28


Ver 4.12.1a
4.13 AppUnregisterUserFromOrg
Desasocia a un usuario de una organización.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nUserID entero Identificador del usuario

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppUnregisterUserFromOrgResponse xmlns="http://keito.com/webservices/">
<AppUnregisterUserFromOrgResult>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</AppUnregisterUserFromOrgResult>
</AppUnregisterUserFromOrgResponse>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve nReturnValue=0.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 22 de 28


Ver 4.12.1a
4.14 AppUpdateUserBirthDateAndSex
Actualiza la fecha de nacimiento y el sexo de un usuario.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nUserID entero Identificador del usuario
dDateOfBirth Fecha Fecha de nacimiento
eSex Enumerado Puede valer sexMale, sexFemale o sexNull.
eSex Véase apéndice A

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppUpdateUserBirthDateAndSexResponse xmlns="http://keito.com/webservices/">
<AppUpdateUserBirthDateAndSexResult>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</AppUpdateUserBirthDateAndSexResult>
</AppUpdateUserBirthDateAndSexResponse>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve nReturnValue=0.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 23 de 28


Ver 4.12.1a
4.15 AppUpdateUserOrganizationClientCode
Actualiza el código interno de un usuario en una organización.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nUserID entero Identificador del usuario
sClientCode cadena Código interno

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppUpdateUserOrganizationClientCodeResponse xmlns="http://keito.com/webservices/">
<AppUpdateUserOrganizationClientCodeResult>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</AppUpdateUserOrganizationClientCodeResult>
</AppUpdateUserOrganizationClientCodeResponse>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve nReturnValue=0.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 24 de 28


Ver 4.12.1a
4.16 AppUpdateUserOrganizationCredit
Actualiza el crédito de un usuario en una organización

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
nUserID entero Identificador del usuario
nNewCredit entero Nuevo valor de crédito

Devuelve
El valor devuelto consiste en un tipo complejo xml cuya estructura es la siguiente:

<AppUpdateUserOrganizationCreditResponse xmlns="http://keito.com/webservices/">
<AppUpdateUserOrganizationCreditResult>
<nErrorCode>resErrNoError or resErrErrorDB or resErrInvalidParameter or
resErrUnexpectedError or resErrInvalidLogin or resErrNoOrganizationAssigned or
resErrNotAutorized or resErrUserNotBelongsToOrg or resErrUserAlreadyBelongsToOrg or
resCannotUpdate</nErrorCode>
<sErrorDescription>string</sErrorDescription>
<sErrorSource>string</sErrorSource>
<sStackTrace>string</sStackTrace>
<nReturnValue>int</nReturnValue>
</AppUpdateUserOrganizationCreditResult>
</AppUpdateUserOrganizationCreditResponse>

Si la operación finaliza con éxito, se devuelve nErrorCode = resErrNoError y se


devuelve nReturnValue=0.

Si la operación falla, nErrorCode devuelve uno de los otros valores posibles y las
cadenas sErrorDescription, sErrorSource y sStackTrace contienen información
detallada de la causa del error.

Servicio Web del sistema Keito e-Health Página 25 de 28


Ver 4.12.1a
4.17 AppUpdateUserOrganizationCreditEx
Actualiza el crédito de un usuario en una organización. Ofrece la misma funcionalidad
que AppUpdateUserOrganizationCredit, pero se utiliza un código de tarjeta magnética
o de código de barras en lugar del identificador de usuario.

Parámetros
Nombre Tipo Descripción
sLoginName cadena Código de usuario administrador de cuenta
sPassWord cadena Clave de acceso
nOrganizationID entero Identificador de la organización
eCardType Enumerado Tipo de código de barras o de tarjeta
eCardTypes magnética. En el apéndice A se describen
los valores posibles.
sCardCode cadena Código de tarjeta del nuevo usuario.
nNewCredit entero Nuevo valor de crédito

Devuelve
El valor devuelto consiste en un tipo idéntico al devuelto por
AppUpdateUserOrganizationCredit.

Servicio Web del sistema Keito e-Health Página 26 de 28


Ver 4.12.1a
4.18 AppVerifyFingerprintMatch
Esta función es para uso interno. No debe llamarse desde aplicaciones de usuario.

4.19 ExecuteCmdK6
Esta función es para uso interno. No debe llamarse desde aplicaciones de usuario.

4.20 GetVersion
Devuelve la versión del Servicio Web de Keito Vital System

Servicio Web del sistema Keito e-Health Página 27 de 28


Ver 4.12.1a
5 Apéndice A. Valores enumerados
5.1 Enumerado eCardTypes
Valores posibles:
Código Descripción
ctMagneticTrack2 Tarjeta magnética. Contenido de pista 2
ctBarcodeUPCA Código de barras UPCA
ctBarcodeUPCE Código de barras UPCE
ctBarcodeEAN13 Código de barras EAN 13
ctBarcodeEAN8 Código de barras EAN 8
ctBarcodeCODE39 Código de barras CODE 39
ctBarcodeCODE128 Código de barras CODE 128
ctBarcodeCODABAR Código de barras CODABAR
ctBarcode2Of5INTERLEAVED Código de barras 2 de 5 entrelazado
ctBarcode2Of5INDUSTRIAL Código de barras 2 de 5 industrial
ctBarcodeMatrix2Of5 Código de barras Matriz 2 de 5
ctBarcodeCODE93 Código de barras CODE 93
ctBarcodeCODE11 Código de barras CODE 11
ctBarcodeMSIPLESSEY Código de barras MSI Plessey
ctBarcodeUKPLESSEY Código de barras UK Plessey
ctBarcodeTELEPEN Código de barras TELEPEN
ctBarcodeUNKNOWN Reservado para posibles ampliaciones.

5.2 Enumerado eSex


Valores posibles:
Código Descripción
sexMale Sexo varón
sexFemale Sexo hembra
sexNull Sexo sin especificar

Servicio Web del sistema Keito e-Health Página 28 de 28


Ver 4.12.1a

También podría gustarte