Exams

Serviço responsável pelas operações de listar, consultar e agendar exames.

Load

Retorna a listagem de agendamentos ativos do título, os tipos de exames disponíveis para agendamento,
sócios que podem realizar o agendamento
e informações sobre as formas de pagamento.

Parâmetros

Nome	Tipo	Descrição
titleId	Int32	Identificador único do título. Obrigatório.

Retorno

Tipo	Descrição
LoadExamsResult	Retorna a listagem de agendamentos ativos do título, os tipos de exames disponíveis para agendamento, sócios que podem realizar o agendamento e informações sobre as formas de pagamento.

LoadIntervals

Retorna os exames disponíveis para agendamento.

Parâmetros

Nome	Tipo	Descrição
data	LoadIntervalData	Dados para consulta de exames disponíveis. Obrigatório.

Retorno

Tipo	Descrição
LoadIntervalResult[]	Retorna exames disponíveis para agendamento.

Schedule

Efetiva o agendamento.

Parâmetros

Nome	Tipo	Descrição
data	ScheduleData	Dados do agendamento do exame. Obrigatório.

Retorno

Tipo	Descrição
ScheduleResult	Retorna se o agendamento foi realizado.

Error codes

Códigos de erro retornados pelo serviço

Valores

Nome	Valor	Descrição
InvalidTitle	0	Título inválido. Ocorre quando não é encontrado o título informado.
InvalidMember	1	Sócio inválido. Ocorre quando não é encontrado o sócio informado.
InvalidCalendar	2	Calendário de exame inválido. Ocorre quando não é encontrado o calendário de exame informado.
InvalidProduct	3	Produto inválido. Ocorre quando não é encontrado o produto informado.
InvalidScheduleDate	4	Data inválida. Ocorre quando a data informada é anterior à data atual.
OfflineMultiVendas	5	Multivendas offline.
PaymentFailed	6	Ocorre quando há falha na operação de pagamento.
InvalidCardData	7	Modo de pagamento cartão de crédito não implementado. Ocorre quando o exame tem um valor mas não há dados do cartão para realizar o pagamento.
UnavailableScheduleDateTime	8	Agendamento indisponível. Ocorre quando a data e horário escolhidos para agendamento não estão disponíveis.
ExamConfigurationNotFound	9	Configuração de exames não implementada. Ocorre quando não há configuração de exames definida.
PaymentModeConfigurationNotFound	10	Configuração de pagamento com cartão não implementada. Ocorre quando não há forma de pagamento para as vendas de cartões de crédito e configuração de instituição de cobrança para exames definidas.
AuthenticationKeyMissing	901	Chave de autenticação não informada.
AuthenticationKeyInvalid	902	Fornecido como parâmetro uma chave de autenticação inválida. Este erro ocorre quando, a chave não é encontrada, quando a chave informada está incorreta ou quando o usuário associado a chave não possui permissão para utilizar a API.
IntegrationDisabled	903	A integração com o aplicativo está desativada. Este erro ocorre devido a configuração na administração do servidor.
IntegratedUserInvalid	904	Usuário de integração inválido.
AuthenticationKeyUserMismatch	905	O nome de usuário de integração no MultiVendas não é igual ao nome de usuário da chave no MultiClubes.