Ninsaúde Apolo

Desenvolvedores

Conecte
sua própria
solução.

A plataforma de desenvolvimento Toro fornece uma API Restful para construir experiências ricas com aplicativos web, mobile e desktop com todos os recursos que a sua clínica precisa.

Plataforma de desenvolvimento Toro

Segurança

A plataforma Toro conta com infraestrutura tecnológica escalonável e segura. Todas as requisições possuem segurança ponta a ponta com certificado de segurança Comodo Secure 2040 bits. Eventualmente, scanners de vulnerabilidades são utilizados para rastrear possíveis falhas de segurança.

A infraestrutura também é certificada por SSAE16 / ISAE 3402 Type II, ISO 27001, ISO 27017, ISO 27018, FedRAMP ATO, PCI DSS v3.2 e HIPAA.

Os tokens utilizados seguem os padrões da autenticação OAUTH2. A utilização do Refresh Token substitui o compartilhamento de conta, usuário e senha com os aplicativos. O Access Token, utilizado nas requisições a plataforma, possui validade de 15 minutos.


Alterações

A plataforma de desenvolvimento Toro está em beta e pode sofrer alterações a qualquer momento.

10/12/2017 – Lançamento oficial da plataforma.


URL

A API Restful da plataforma de desenvolvimento Toro pode ser acessada pela URL:

https://api.ninsaude.com/v1/[CONTROLLER]/[ROTA]?[PARÂMETROS]

Todas as requisições devem utilizar HTTPS e cabeçalho “Authorization: bearer [ACCESS_TOKEN]” e “Content-Type: application/json”.


Autenticação

A autenticação da plataforma de desenvolvimento Toro possui dois tokens. O Refresh Token e o Access Token.

O Refresh Token é utilizado somente para capturar novos Access Token. Esse token não possui validade e deve ser armazenado com segurança máxima.

Já o Access Token é utilizado em todos os cabeçalhos de requisições. Esse token possui validade de 15 minutos e é semelhante a uma sessão de usuários.

Capturar Refresh Token


Revogar Refresh Token


Capturar Access Token


Retornos

O cabeçalho de retorno das requisições pode conter status diferente de 200. Confira a lista de status abaixo:

200 – Sem erro.
400 – Requisição mal formada (exemplo: rota, método, parâmetros ou tipos de parâmetros).
401 – Sessão expirou.
403 – Usuário não possui acesso ao recurso (Configurações / Usuários / Grupos / Restrições).
404 – Registro não encontrado.
500 – Erro grave ou regra de negócio.
501 – Erro na programação. Os programadores são alertados sempre que esse status é disparado.
503 – Serviços indisponíveis (exemplo: aplicação, banco de dados ou integrações).

Já o corpo das requisições possui formato JSON para reduzir a latência entre a plataforma Toro e os aplicativos.


Erros

Os erros podem ser tratados pelo status e corpo das requisições. O corpo das requisições são objetos no formato JSON com as seguintes propriedades: code, status do erro; e message, mensagem do erro.

Exemplo:

{
	"error":[
		{"code": 404, "message": "Registro não encontrado."}
	]
}
 

UNIDADES DE ATENDIMENTO account_geral

 
LISTAR UNIDADES
get
account_geral/listar

Nome Tipo Descrição
ativo boolean Ativo (optional).
id integer Índice da unidade (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
account_geral/{id:^[0-9]++$}

https://api.ninsaude.com/v1/account_geral/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "wwww",
        "ativo": 0,
        "unidade": "wwww",
        "enderecoCep": null,
        "enderecoCidade": 139716,
        "enderecoBairro": null,
        "enderecoLogradouro": null,
        "lingua": "pt-br",
        "codPais": 54,
        "ddd": 11,
        "foneComercial": 111111,
        "timezone": 17,
        "responsavelNome": "wwww",
        "responsavelEmail": "wwww@wwww.com",
        "responsavelDocumento": null,
        "prontuarioCompartilhado": 1,
        "logotipo": 0,
        "fichaPaciente": "cc|rc|hi",
        "agendaCor": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
account_geral/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
account_geral/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
account_geral
put
account_geral/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
unidade alphaNumeric A propriedade "unidade" é obrigatória. A propriedade "unidade" deve possuir tamanho mínimo de "3" e máximo de "45".
enderecoCep alphaNumeric A propriedade "enderecoCep" deve possuir tamanho mínimo de "8" e máximo de "10".
enderecoCidade integer
enderecoBairro alphaNumeric A propriedade "enderecoBairro" deve possuir tamanho mínimo de "3" e máximo de "80".
enderecoLogradouro alphaNumeric A propriedade "enderecoLogradouro" deve possuir tamanho mínimo de "3" e máximo de "100".
lingua alphaNumeric A propriedade "lingua" é obrigatória.
codPais alphaNumeric A propriedade "codPais" é obrigatória. A propriedade "codPais" deve possuir tamanho mínimo de "1" e máximo de "5".
ddd alphaNumeric A propriedade "ddd" é obrigatória. A propriedade "ddd" deve possuir tamanho mínimo de "1" e máximo de "3".
foneComercial alphaNumeric A propriedade "foneComercial" é obrigatória. A propriedade "foneComercial" deve possuir tamanho mínimo de "3" e máximo de "15".
timezone integer A propriedade "timezone" é obrigatória.
responsavelNome alphaNumeric A propriedade "responsavelNome" é obrigatória. A propriedade "responsavelNome" deve possuir tamanho mínimo de "3" e máximo de "80".
responsavelEmail alphaNumeric A propriedade "responsavelEmail" é obrigatória. A propriedade "responsavelEmail" deve possuir tamanho mínimo de "3" e máximo de "80".
responsavelDocumento document
prontuarioCompartilhado boolean A propriedade "prontuarioCompartilhado" é obrigatória.
logotipo integer
fichaPaciente alphaNumeric A propriedade "fichaPaciente" deve possuir tamanho mínimo de "2" e máximo de "24".
agendaCor boolean A propriedade "agendaCor" é obrigatória.
https://api.ninsaude.com/v1/account_geral

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 1734,
    "error": []
}
 
EXCLUIR OBJETO
delete
account_geral/{id:^[0-9]++$}

https://api.ninsaude.com/v1/account_geral/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

AGENDAMENTOS DE PACIENTES atendimento_agenda

 
LISTAR AGENDAMENTOS
get
atendimento_agenda/listar
get
atendimento_agenda/listar/agendamento/dataInicial/{dataInicial}/dataFinal/{dataFinal}
get
atendimento_agenda/listar/agendamento/profissional/{profissional}/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).
status mixed Status dos agendamentos (optional).
paciente mixed Indíce dos pacientes (optional).
profissional mixed Índice dos profissionais (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).
hashRecurso string Hash de recursos (optional).
limite integer Limite de linhas (optional).
id integer Índice do agendamento (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR RETORNO
get
atendimento_agenda/listar/retorno/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
horaInicialInicial string Hora inicial (optional).
horaInicialFinal string Hora inicial final (optional).
accountUnidade array Unidade (optional).

 
LISTAR CONVÊNIOS POR PACIENTE
get
atendimento_agenda/listar/convenio/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.

 
LISTAR ACOMPANHANTES
get
atendimento_agenda/listar/acompanhante/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.

 
LISTAR HORÁRIOS VAGOS PARA PACIENTES COM ALERTA DE VAGAS
get
atendimento_agenda/listar/horario/alerta/vaga

Nome Tipo Descrição
profissional mixed Índice dos profissional (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).

 
LISTAR HORÁRIOS DISPONÍVEIS POR PROFISSIONAL
get
atendimento_agenda/listar/horario/disponivel/profissional/{profissional}/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
profissional mixed Índice do profissional.
accountUnidade mixed Índice das unidades de atendimento (optional).
duracao integer Duração (optional).

 
LISTAR OCUPAÇÃO DA AGENDA
get
atendimento_agenda/listar/ocupacao/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial mixed Data inicial.
dataFinal mixed Data final.
profissional mixed Índice dos profissionais (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).

 
BUSCAR CONVÊNIO DO PACIENTE
get
atendimento_agenda/buscar/convenio/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
convenio integer Índice do convênio (opcional).

 
ABRIR REGISTROS EM PILHA POR HASH RECURSO
get
atendimento_agenda/bulk/hashRecurso/{hashRecurso}

Nome Tipo Descrição
hashRecurso string Hash do recurso.

 
BUSCAR HASH PARA PREENCHER FICHA CADASTRAL
get
atendimento_agenda/buscar/hash/ficha/cadastral/agendamento/{agendamento}

Nome Tipo Descrição
agendamento integer Índice do agendamento.

 
ALTERAR STATUS POR AGENDAMENTO
put
atendimento_agenda/alterar/status/agendamento/{agendamento}

Nome Tipo Descrição
status integer Status.
agendamento integer Índice do agendamento.
https://api.ninsaude.com/v1/atendimento_agenda/alterar/status/agendamento/116769

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9687,
    "error": []
}
 
REMOVER RECURSOS EM LOTE
delete
atendimento_agenda/remover/lote/recurso/hash/{hash}

Nome Tipo Descrição
hash integer Hash dos recursos.
https://api.ninsaude.com/v1/atendimento_agenda/remover/lote/recurso/hash/78cfe121d183b6a406fff1fa269e7777

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 
ABRIR OBJETO
get
atendimento_agenda/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agenda/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "profissional": 1,
        "data": "2017-10-31",
        "horaInicial": "10:00:00",
        "horaFinal": "10:30:00",
        "horaChegada": null,
        "paciente": 11558,
        "status": 0,
        "convenio": null,
        "convenioPlano": null,
        "convenioCarteira": null,
        "convenioValidade": null,
        "servico": 18,
        "especialidade": 1,
        "encaminhador": null,
        "hashRecurso": null,
        "alertaVaga": 0,
        "acompanhanteNome": null,
        "acompanhanteTelefone": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
atendimento_agenda/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
atendimento_agenda/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
atendimento_agenda
put
atendimento_agenda/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
data date A propriedade "data" é obrigatória.
horaInicial time A propriedade "horaInicial" é obrigatória.
horaFinal time A propriedade "horaFinal" é obrigatória. A propriedade "horaFinal" deve possuir data compatível com a expressão "horaFinal > horaInicial".
horaChegada time
paciente integer A propriedade "paciente" é obrigatória.
status integer A propriedade "status" é obrigatória.
convenio integer
convenioPlano integer
convenioCarteira alphaNumeric A propriedade "convenioCarteira" deve possuir tamanho mínimo de "3" e máximo de "20".
convenioValidade date
servico integer A propriedade "servico" é obrigatória.
especialidade integer A propriedade "especialidade" é obrigatória.
encaminhador integer
hashRecurso alphaNumeric A propriedade "hashRecurso" deve possuir tamanho mínimo de "3" e máximo de "33".
alertaVaga boolean
acompanhanteNome alphaNumeric A propriedade "acompanhanteNome" deve possuir tamanho mínimo de "3" e máximo de "120".
acompanhanteTelefone alphaNumeric A propriedade "acompanhanteTelefone" deve possuir tamanho mínimo de "8" e máximo de "16".
https://api.ninsaude.com/v1/atendimento_agenda

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8436,
    "error": []
}
 
EXCLUIR OBJETO
delete
atendimento_agenda/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agenda/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 
ABRIR OBJETOS EM PILHA
get
atendimento_agenda/bulk/id/{id}

https://api.ninsaude.com/v1/atendimento_agenda/bulk/id/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "profissional": 1,
        "data": "2017-10-31",
        "horaInicial": "10:00:00",
        "horaFinal": "10:30:00",
        "horaChegada": null,
        "paciente": 11558,
        "status": 0,
        "convenio": null,
        "convenioPlano": null,
        "convenioCarteira": null,
        "convenioValidade": null,
        "servico": 18,
        "especialidade": 1,
        "encaminhador": null,
        "hashRecurso": null,
        "alertaVaga": 0,
        "acompanhanteNome": null,
        "acompanhanteTelefone": null
    },
    "error": []
}
 
SALVAR OBJETOS EM PILHA
post
atendimento_agenda/bulk
put
atendimento_agenda/bulk

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
data date A propriedade "data" é obrigatória.
horaInicial time A propriedade "horaInicial" é obrigatória.
horaFinal time A propriedade "horaFinal" é obrigatória. A propriedade "horaFinal" deve possuir data compatível com a expressão "horaFinal > horaInicial".
horaChegada time
paciente integer A propriedade "paciente" é obrigatória.
status integer A propriedade "status" é obrigatória.
convenio integer
convenioPlano integer
convenioCarteira alphaNumeric A propriedade "convenioCarteira" deve possuir tamanho mínimo de "3" e máximo de "20".
convenioValidade date
servico integer A propriedade "servico" é obrigatória.
especialidade integer A propriedade "especialidade" é obrigatória.
encaminhador integer
hashRecurso alphaNumeric A propriedade "hashRecurso" deve possuir tamanho mínimo de "3" e máximo de "33".
alertaVaga boolean
acompanhanteNome alphaNumeric A propriedade "acompanhanteNome" deve possuir tamanho mínimo de "3" e máximo de "120".
acompanhanteTelefone alphaNumeric A propriedade "acompanhanteTelefone" deve possuir tamanho mínimo de "8" e máximo de "16".
https://api.ninsaude.com/v1/atendimento_agenda/bulk

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": [
        5693,
        1320
    ],
    "error": []
}
 

LAYOUT DAS CARTEIRINHAS atendimento_agendacarteira

 
SALVAR OBJETOS
post
atendimento_agendacarteira

Nome Tipo Descrição
id integer
agendamento integer A propriedade "agendamento" é obrigatória.
layout alphaNumeric A propriedade "layout" é obrigatória. A propriedade "layout" deve possuir tamanho mínimo de "3" e máximo de "1000".
https://api.ninsaude.com/v1/atendimento_agendacarteira

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2663,
    "error": []
}
 

AGENDAMENTOS RECORRÊNTES atendimento_agendarecorrente

 
LISTAR RECORRÊNCIAS
get
atendimento_agendarecorrente/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade mixed Índice das unidades de atendimento (optional).
profissional mixed Índice dos profissionais (optional).
filter string Filtro nativo do framework (optional).

 
ABRIR OBJETO
get
atendimento_agendarecorrente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendarecorrente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "profissional": 21,
        "horaInicial": "14:00:00",
        "horaFinal": "14:30:00",
        "paciente": 37,
        "convenio": null,
        "convenioPlano": null,
        "convenioCarteira": null,
        "convenioValidade": null,
        "servico": 18,
        "especialidade": 7,
        "encaminhador": null,
        "repetirDataInicial": "2017-05-24",
        "repetirDataFinal": null,
        "repetirIntervaloDia": null,
        "repetirAno": null,
        "repetirMes": null,
        "repetirDia": null,
        "repetirSemanaAno": null,
        "repetirSemanaMes": null,
        "repetirSemanaDia": 3,
        "repetirNumeroOcorrencia": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
atendimento_agendarecorrente/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
atendimento_agendarecorrente/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
atendimento_agendarecorrente
put
atendimento_agendarecorrente/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
horaInicial time A propriedade "horaInicial" é obrigatória.
horaFinal time A propriedade "horaFinal" é obrigatória. A propriedade "horaFinal" deve possuir data compatível com a expressão "horaFinal > horaInicial".
paciente integer A propriedade "paciente" é obrigatória.
convenio integer
convenioPlano integer
convenioCarteira alphaNumeric A propriedade "convenioCarteira" deve possuir tamanho mínimo de "3" e máximo de "20".
convenioValidade date
servico integer A propriedade "servico" é obrigatória.
especialidade integer A propriedade "especialidade" é obrigatória.
encaminhador integer
repetirDataInicial date A propriedade "repetirDataInicial" é obrigatória.
repetirDataFinal date
repetirIntervaloDia integer A propriedade "repetirIntervaloDia" deve possuir valor compatível com a expressão "repetirIntervaloDia > 0".
repetirAno integer A propriedade "repetirAno" deve possuir valor mínimo de "1980" e máximo de "2100".
repetirMes integer A propriedade "repetirMes" deve possuir valor mínimo de "1" e máximo de "12".
repetirDia integer A propriedade "repetirDia" deve possuir valor mínimo de "1" e máximo de "31".
repetirSemanaAno integer A propriedade "repetirSemanaAno" deve possuir valor mínimo de "1" e máximo de "52".
repetirSemanaMes integer A propriedade "repetirSemanaMes" deve possuir valor mínimo de "1" e máximo de "5".
repetirSemanaDia
Notice: Array to string conversion in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 170
Array
repetirNumeroOcorrencia integer A propriedade "repetirNumeroOcorrencia" deve possuir valor compatível com a expressão "repetirNumeroOcorrencia > 0".
https://api.ninsaude.com/v1/atendimento_agendarecorrente

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 4114,
    "error": []
}
 
EXCLUIR OBJETO
delete
atendimento_agendarecorrente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendarecorrente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

RECORRÊNCIAS DO AGENDAMENTO atendimento_agendarecorrenteocorrencia

 
LISTAR OCORRÊNCIAS
get
atendimento_agendarecorrenteocorrencia/listar/recorrencia/{recorrencia}

Nome Tipo Descrição
recorrencia integer Índice da recorrência.

 
ADICIONAR OCORRÊNCIA DO TIPO AGENDAMENTO
post
atendimento_agendarecorrenteocorrencia/adicionar/agendamento/recorrencia/{recorrencia}

Nome Tipo Descrição
id integer
agendamentoRecorrente integer A propriedade "agendamentoRecorrente" é obrigatória.
status integer A propriedade "status" é obrigatória.
data date A propriedade "data" é obrigatória.
agendamento integer
https://api.ninsaude.com/v1/atendimento_agendarecorrenteocorrencia/adicionar/agendamento/recorrencia/3

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 985,
    "error": []
}
 
MARCAR DATA COMO NÃO USADA
post
atendimento_agendarecorrenteocorrencia/marcar/data/nao/usada/recorrencia/{recorrencia}

Nome Tipo Descrição
id integer
agendamentoRecorrente integer A propriedade "agendamentoRecorrente" é obrigatória.
status integer A propriedade "status" é obrigatória.
data date A propriedade "data" é obrigatória.
agendamento integer
https://api.ninsaude.com/v1/atendimento_agendarecorrenteocorrencia/marcar/data/nao/usada/recorrencia/3

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 397,
    "error": []
}
 
ABRIR OBJETO
get
atendimento_agendarecorrenteocorrencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendarecorrenteocorrencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "agendamentoRecorrente": 19,
        "status": 0,
        "data": "2017-10-31",
        "agendamento": 128517
    },
    "error": []
}
 
BUSCAR OBJETOS
get
atendimento_agendarecorrenteocorrencia/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
atendimento_agendarecorrenteocorrencia/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
atendimento_agendarecorrenteocorrencia
put
atendimento_agendarecorrenteocorrencia/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
agendamentoRecorrente integer A propriedade "agendamentoRecorrente" é obrigatória.
status integer A propriedade "status" é obrigatória.
data date A propriedade "data" é obrigatória.
agendamento integer
https://api.ninsaude.com/v1/atendimento_agendarecorrenteocorrencia

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3900,
    "error": []
}
 
EXCLUIR OBJETO
delete
atendimento_agendarecorrenteocorrencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendarecorrenteocorrencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

SERVIÇOS ADICIONAIS DAS RECORRÊNCIAS atendimento_agendarecorrenteservicoadicional

 
LISTAR SERVIÇOS ADICIONAIS
get
atendimento_agendarecorrenteservicoadicional/listar/recorrencia
get
atendimento_agendarecorrenteservicoadicional/listar/recorrencia/{recorrencia}

Nome Tipo Descrição
recorrencia integer Índice das recorrências.

 
ALTERAR EM LOTES
put
atendimento_agendarecorrenteservicoadicional/alterar/lote/recorrencia/{recorrencia}

Nome Tipo Descrição
recorrencia integer Índice da recorrência.
servico array Índice dos serviços.
https://api.ninsaude.com/v1/atendimento_agendarecorrenteservicoadicional/alterar/lote/recorrencia/3

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3106,
    "error": []
}
 
ABRIR OBJETO
get
atendimento_agendarecorrenteservicoadicional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendarecorrenteservicoadicional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "recorrencia": 19,
        "servico": 18
    },
    "error": []
}
 
BUSCAR OBJETOS
get
atendimento_agendarecorrenteservicoadicional/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
atendimento_agendarecorrenteservicoadicional/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
atendimento_agendarecorrenteservicoadicional
put
atendimento_agendarecorrenteservicoadicional/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
recorrencia integer A propriedade "recorrencia" é obrigatória.
servico integer A propriedade "servico" é obrigatória.
https://api.ninsaude.com/v1/atendimento_agendarecorrenteservicoadicional

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2423,
    "error": []
}
 
EXCLUIR OBJETO
delete
atendimento_agendarecorrenteservicoadicional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendarecorrenteservicoadicional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

SERVIÇOS ADICIONAIS atendimento_agendaservicoadicional

 
LISTAR SERVIÇOS ADICIONAIS
get
atendimento_agendaservicoadicional/listar/agendamento
get
atendimento_agendaservicoadicional/listar/agendamento/{agendamento}

Nome Tipo Descrição
agendamento mixed Índice dos agendamentos.
servicoPrincipal integer Listar serviço principal (optional)?

 
ALTERAR EM LOTE
put
atendimento_agendaservicoadicional/alterar/lote/agendamento/{agendamento}

Nome Tipo Descrição
agendamento integer Índice do agendamento.
servico array Índice dos serviços.
https://api.ninsaude.com/v1/atendimento_agendaservicoadicional/alterar/lote/agendamento/116769

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 956,
    "error": []
}
 
ALTERAR EM LOTE
put
atendimento_agendaservicoadicional/bulk/alterar/lote/agendamento

https://api.ninsaude.com/v1/atendimento_agendaservicoadicional/bulk/alterar/lote/agendamento

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": [
        41,
        352
    ],
    "error": []
}
 
ABRIR OBJETO
get
atendimento_agendaservicoadicional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendaservicoadicional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "agendamento": 128517,
        "servico": 18
    },
    "error": []
}
 
BUSCAR OBJETOS
get
atendimento_agendaservicoadicional/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
atendimento_agendaservicoadicional/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
atendimento_agendaservicoadicional
put
atendimento_agendaservicoadicional/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
agendamento integer A propriedade "agendamento" é obrigatória.
servico integer A propriedade "servico" é obrigatória.
https://api.ninsaude.com/v1/atendimento_agendaservicoadicional

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9837,
    "error": []
}
 
EXCLUIR OBJETO
delete
atendimento_agendaservicoadicional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_agendaservicoadicional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 
ABRIR OBJETOS EM PILHA
get
atendimento_agendaservicoadicional/bulk/id/{id}

https://api.ninsaude.com/v1/atendimento_agendaservicoadicional/bulk/id/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "agendamento": 128517,
        "servico": 18
    },
    "error": []
}
 
SALVAR OBJETOS EM PILHA
post
atendimento_agendaservicoadicional/bulk
put
atendimento_agendaservicoadicional/bulk

Nome Tipo Descrição
id integer
agendamento integer A propriedade "agendamento" é obrigatória.
servico integer A propriedade "servico" é obrigatória.
https://api.ninsaude.com/v1/atendimento_agendaservicoadicional/bulk

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": [
        8104,
        2129
    ],
    "error": []
}
 

EVENTOS atendimento_evento

 
LISTAR EVENTOS
get
atendimento_evento/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}
get
atendimento_evento/listar/profissional/{profissional}/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
profissional mixed Índice dos profissionais (optional).

 
REMOVER EM LOTE
delete
atendimento_evento/remover/lote/evento/{evento}

Nome Tipo Descrição
evento mixed Índice dos eventos.

Notice: Undefined index: {evento} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/atendimento_evento/remover/lote/evento/ Content-type: application/json Authorization: bearer <<access_token>> { "result": true, "error": [] }
 
ABRIR OBJETO
get
atendimento_evento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_evento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "profissional": 79,
        "dataInicial": "2017-10-18",
        "dataFinal": "2017-10-18",
        "horaInicial": "00:00:00",
        "horaFinal": "23:59:59",
        "descricao": "Data bloqueada",
        "bloquear": 1,
        "hash": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
atendimento_evento/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
atendimento_evento/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
atendimento_evento
put
atendimento_evento/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
profissional integer A propriedade "profissional" é obrigatória.
dataInicial date A propriedade "dataInicial" é obrigatória.
dataFinal date A propriedade "dataFinal" é obrigatória. A propriedade "dataFinal" deve possuir data compatível com a expressão "dataFinal >= dataInicial".
horaInicial time A propriedade "horaInicial" é obrigatória.
horaFinal time A propriedade "horaFinal" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "120".
bloquear boolean
hash alphaNumeric A propriedade "hash" deve possuir tamanho mínimo de "3" e máximo de "45".
https://api.ninsaude.com/v1/atendimento_evento

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 4194,
    "error": []
}
 
EXCLUIR OBJETO
delete
atendimento_evento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/atendimento_evento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 
ABRIR OBJETOS EM PILHA
get
atendimento_evento/bulk/id/{id}

https://api.ninsaude.com/v1/atendimento_evento/bulk/id/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "profissional": 79,
        "dataInicial": "2017-10-18",
        "dataFinal": "2017-10-18",
        "horaInicial": "00:00:00",
        "horaFinal": "23:59:59",
        "descricao": "Data bloqueada",
        "bloquear": 1,
        "hash": null
    },
    "error": []
}
 
SALVAR OBJETOS EM PILHA
post
atendimento_evento/bulk
put
atendimento_evento/bulk

Nome Tipo Descrição
id integer
profissional integer A propriedade "profissional" é obrigatória.
dataInicial date A propriedade "dataInicial" é obrigatória.
dataFinal date A propriedade "dataFinal" é obrigatória. A propriedade "dataFinal" deve possuir data compatível com a expressão "dataFinal >= dataInicial".
horaInicial time A propriedade "horaInicial" é obrigatória.
horaFinal time A propriedade "horaFinal" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "120".
bloquear boolean
hash alphaNumeric A propriedade "hash" deve possuir tamanho mínimo de "3" e máximo de "45".
https://api.ninsaude.com/v1/atendimento_evento/bulk

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": [
        3495,
        1675
    ],
    "error": []
}
 

GRÁFICOS DA AGENDA atendimento_grafico

 
SOBRECARGA
get
atendimento_grafico/listar/sobrecarga/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
SAZONALIDADE
get
atendimento_grafico/listar/sazonalidade/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
SEXO DOS PACIENTES
get
atendimento_grafico/listar/sexo/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
TEMPO MÉDIO EM SALA DE ESPERA
get
atendimento_grafico/listar/emEspera/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
DURAÇÃO DOS ATENDIMENTOS
get
atendimento_grafico/listar/duracao/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
CONVÊNIOS MAIS UTILIZADOS
get
atendimento_grafico/listar/convenio/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
SERVIÇOS MAIS UTILIZADOS
get
atendimento_grafico/listar/servico/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
QUANTIDADE DE AGENDAMENTOS ATENDIDOS, FALTAS, CANCELADOS E REAGENDADOS
get
atendimento_grafico/listar/agendamento/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
HORÁRIOS DE PICO
get
atendimento_grafico/listar/pico/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
ENCAMINHADORES
get
atendimento_grafico/listar/encaminhador/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
SERVIÇOS MAIS VENDIDOS
get
atendimento_grafico/listar/servico/mais/vendido/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
SERVIÇOS MAIS RENTÁVEIS
get
atendimento_grafico/listar/servico/mais/rentavel/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
CONVÊNIOS MAIS VENDIDOS
get
atendimento_grafico/listar/convenio/mais/vendido/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
CONVÊNIOS MAIS RENTÁVEIS
get
atendimento_grafico/listar/convenio/mais/rentavel/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
LISTAR MAPA
get
atendimento_grafico/listar/mapa/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 

CATEGORIAS FINANCEIRAS cadastro_categoria

 
LISTAR CATEGORIAS
get
cadastro_categoria/listar

Nome Tipo Descrição
descricao string Descrição (optional).
tipo integer Tipo de categoria (optional).
ativo boolean Categoria ativa (optional)
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_categoria/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_categoria/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "Receber 8",
        "ativo": 1,
        "tipo": 0
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_categoria/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_categoria/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_categoria
put
cadastro_categoria/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
tipo boolean A propriedade "tipo" é obrigatória.
https://api.ninsaude.com/v1/cadastro_categoria

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 7238,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_categoria/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_categoria/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

SUBCATEGORIAS cadastro_categoriasub

 
LISTAR SUBCATEGORIAS
get
cadastro_categoriasub/listar

Nome Tipo Descrição
descricao string Descrição (optional).
categoria mixed Índice das categorias (optional).
tipo integer Tipo de subcategoria (0 = despesas, 1 = receitas, optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_categoriasub/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_categoriasub/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "categoria": 30,
        "descricao": "bitcoins type 3"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_categoriasub/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_categoriasub/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_categoriasub
put
cadastro_categoriasub/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
categoria integer A propriedade "categoria" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
https://api.ninsaude.com/v1/cadastro_categoriasub

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2778,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_categoriasub/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_categoriasub/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

COMPLEMENTOS cadastro_complemento

 
LISTAR COMPLEMENTOS
get
cadastro_complemento/listar

Nome Tipo Descrição
filter mixed Filtro nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_complemento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_complemento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "titulo": "wqqwqw",
        "note": "qqq"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_complemento/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_complemento/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_complemento
put
cadastro_complemento/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
titulo alphaNumeric A propriedade "titulo" é obrigatória. A propriedade "titulo" deve possuir tamanho mínimo de "3" e máximo de "45".
note alphaNumeric
https://api.ninsaude.com/v1/cadastro_complemento

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9023,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_complemento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_complemento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

CONVÊNIOS cadastro_convenio

 
LISTAR CONVÊNIOS
get
cadastro_convenio/listar

Nome Tipo Descrição
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_convenio/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_convenio/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "titulo": "Testando 2",
        "ativo": 1,
        "email": null,
        "enderecoCep": null,
        "enderecoCidade": 38486,
        "enderecoBairro": null,
        "enderecoLogradouro": null,
        "foneCelular": null,
        "foneComercial": null,
        "contato1Descricao": null,
        "contato1FoneComercial": null,
        "contato1Email": null,
        "contato2Descricao": null,
        "contato2FoneComercial": null,
        "contato2Email": null,
        "pagadorDescricao": null,
        "pagadorDocumento": null,
        "retornoDia": 30,
        "observacao": null,
        "geraTiss": 1,
        "tissOperadora": null,
        "tissTabela": null,
        "tissWSElegibilidade": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_convenio/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_convenio/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_convenio
put
cadastro_convenio/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
titulo alphaNumeric A propriedade "titulo" é obrigatória. A propriedade "titulo" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
email email
enderecoCep alphaNumeric A propriedade "enderecoCep" deve possuir tamanho mínimo de "8" e máximo de "10".
enderecoCidade integer
enderecoBairro alphaNumeric A propriedade "enderecoBairro" deve possuir tamanho mínimo de "3" e máximo de "80".
enderecoLogradouro alphaNumeric A propriedade "enderecoLogradouro" deve possuir tamanho mínimo de "3" e máximo de "100".
foneCelular alphaNumeric A propriedade "foneCelular" deve possuir tamanho mínimo de "8" e máximo de "16".
foneComercial alphaNumeric A propriedade "foneComercial" deve possuir tamanho mínimo de "8" e máximo de "16".
contato1Descricao alphaNumeric A propriedade "contato1Descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
contato1FoneComercial alphaNumeric A propriedade "contato1FoneComercial" deve possuir tamanho mínimo de "8" e máximo de "16".
contato1Email email
contato2Descricao alphaNumeric A propriedade "contato2Descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
contato2FoneComercial alphaNumeric A propriedade "contato2FoneComercial" deve possuir tamanho mínimo de "8" e máximo de "16".
contato2Email email
pagadorDescricao alphaNumeric A propriedade "pagadorDescricao" deve possuir tamanho mínimo de "3" e máximo de "120".
pagadorDocumento alphaNumeric
retornoDia integer
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "2000".
geraTiss boolean A propriedade "geraTiss" é obrigatória.
tissOperadora integer
tissTabela integer
tissWSElegibilidade url
https://api.ninsaude.com/v1/cadastro_convenio

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 6155,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_convenio/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_convenio/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PLANOS DE CONVÊNIOS cadastro_convenioplano

 
LISTAR PLANOS
get
cadastro_convenioplano/listar

Nome Tipo Descrição
descricao string Descrição (optional).
convenio mixed Índice dos convênios (optional).
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_convenioplano/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_convenioplano/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "convenio": 144,
        "descricao": "qweqweqweqe222",
        "ativo": 0
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_convenioplano/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_convenioplano/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_convenioplano
put
cadastro_convenioplano/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
convenio integer A propriedade "convenio" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
https://api.ninsaude.com/v1/cadastro_convenioplano

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5008,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_convenioplano/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_convenioplano/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

DOCUMENTOS cadastro_documento

 
LISTAR DOCUMENTOS
get
cadastro_documento/listar

Nome Tipo Descrição
titulo string Título (optional).
tipo mixed Tipo (optional).
filter mixed Filtro nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_documento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_documento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "tipo": 0,
        "titulo": "Complexa",
        "note": "<p>Ol\u00e1<\/p><p>[checkup_ultimo_laudo]<\/p><p>Ol\u00e1<\/p>"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_documento/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_documento/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_documento
put
cadastro_documento/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
tipo integer
titulo alphaNumeric A propriedade "titulo" é obrigatória. A propriedade "titulo" deve possuir tamanho mínimo de "3" e máximo de "45".
note alphaNumeric
https://api.ninsaude.com/v1/cadastro_documento

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 319,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_documento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_documento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

ENCAMINHADORES cadastro_encaminhador

 
LISTAR ENCAMINHADORES
get
cadastro_encaminhador/listar

Nome Tipo Descrição
nome string Nome (optional).
ativo boolean Ativo (optional).
filter mixed Filtro nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_encaminhador/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_encaminhador/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "nome": "werwerwerer",
        "ativo": 1,
        "telefone": null,
        "email": null,
        "enderecoCep": null,
        "enderecoCidade": null,
        "enderecoBairro": null,
        "enderecoLogradouro": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_encaminhador/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_encaminhador/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_encaminhador
put
cadastro_encaminhador/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
nome alphaNumeric A propriedade "nome" é obrigatória. A propriedade "nome" deve possuir tamanho mínimo de "3" e máximo de "120".
ativo boolean A propriedade "ativo" é obrigatória.
telefone alphaNumeric A propriedade "telefone" deve possuir tamanho mínimo de "8" e máximo de "16".
email email
enderecoCep alphaNumeric A propriedade "enderecoCep" deve possuir tamanho mínimo de "8" e máximo de "10".
enderecoCidade integer
enderecoBairro alphaNumeric A propriedade "enderecoBairro" deve possuir tamanho mínimo de "3" e máximo de "80".
enderecoLogradouro alphaNumeric A propriedade "enderecoLogradouro" deve possuir tamanho mínimo de "3" e máximo de "100".
https://api.ninsaude.com/v1/cadastro_encaminhador

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2335,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_encaminhador/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_encaminhador/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

FORNECEDORES cadastro_fornecedor

 
LISTAR FORNECEDORES
get
cadastro_fornecedor/listar

Nome Tipo Descrição
nomeFantasia string Nome fantasia (optional).
nomeContato string Nome do contato (optional).
ativo boolean Ativo (optional).
filter mixed Filtro nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_fornecedor/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_fornecedor/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "nomeFantasia": "qweweqwe",
        "nomeContato": null,
        "ativo": 1,
        "cnpj": null,
        "ie": null,
        "email": null,
        "site": null,
        "enderecoCep": null,
        "enderecoCidade": null,
        "enderecoBairro": null,
        "enderecoLogradouro": null,
        "foneCelular": null,
        "foneComercial": null,
        "foneResidencial": null,
        "observacao": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_fornecedor/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_fornecedor/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_fornecedor
put
cadastro_fornecedor/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
nomeFantasia alphaNumeric A propriedade "nomeFantasia" é obrigatória. A propriedade "nomeFantasia" deve possuir tamanho mínimo de "3" e máximo de "120".
nomeContato alphaNumeric A propriedade "nomeContato" deve possuir tamanho mínimo de "3" e máximo de "120".
ativo boolean A propriedade "ativo" é obrigatória.
cnpj document
ie alphaNumeric A propriedade "ie" deve possuir tamanho mínimo de "9" e máximo de "14".
email email
site alphaNumeric A propriedade "site" deve possuir tamanho mínimo de "3" e máximo de "120".
enderecoCep alphaNumeric A propriedade "enderecoCep" deve possuir tamanho mínimo de "8" e máximo de "10".
enderecoCidade integer
enderecoBairro alphaNumeric A propriedade "enderecoBairro" deve possuir tamanho mínimo de "3" e máximo de "80".
enderecoLogradouro alphaNumeric A propriedade "enderecoLogradouro" deve possuir tamanho mínimo de "3" e máximo de "100".
foneCelular alphaNumeric A propriedade "foneCelular" deve possuir tamanho mínimo de "8" e máximo de "16".
foneComercial alphaNumeric A propriedade "foneComercial" deve possuir tamanho mínimo de "8" e máximo de "16".
foneResidencial alphaNumeric A propriedade "foneResidencial" deve possuir tamanho mínimo de "8" e máximo de "16".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "255".
https://api.ninsaude.com/v1/cadastro_fornecedor

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8173,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_fornecedor/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_fornecedor/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PACIENTES cadastro_paciente

 
LISTAR PACIENTES
get
cadastro_paciente/listar

Nome Tipo Descrição
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR ANIVERSARIANTES
get
cadastro_paciente/listar/aniversariante/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.

 
ABRIR OBJETO
get
cadastro_paciente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_paciente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "nome": "xuxuxu",
        "ativo": 1,
        "nomeMae": null,
        "nomePai": null,
        "cpf": null,
        "cns": null,
        "email": null,
        "dataNascimento": null,
        "estadoCivil": null,
        "racaCor": null,
        "sexo": null,
        "profissao": null,
        "enderecoCep": null,
        "enderecoCidade": null,
        "enderecoBairro": null,
        "enderecoLogradouro": null,
        "foneCelular": null,
        "foneComercial": null,
        "foneResidencial": null,
        "observacao": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_paciente/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_paciente/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_paciente
put
cadastro_paciente/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
nome alphaNumeric A propriedade "nome" é obrigatória. A propriedade "nome" deve possuir tamanho mínimo de "3" e máximo de "120".
ativo boolean A propriedade "ativo" é obrigatória.
nomeMae alphaNumeric A propriedade "nomeMae" deve possuir tamanho mínimo de "3" e máximo de "120".
nomePai alphaNumeric A propriedade "nomePai" deve possuir tamanho mínimo de "3" e máximo de "120".
cpf document A propriedade "cpf" deve possuir tamanho mínimo de "11" e máximo de "11".
cns alphaNumeric
email email
dataNascimento date
estadoCivil integer
racaCor integer
sexo alphaNumeric A propriedade "sexo" deve possuir um dos valores da lista "M, F".
profissao alphaNumeric A propriedade "profissao" deve possuir tamanho mínimo de "3" e máximo de "25".
enderecoCep alphaNumeric A propriedade "enderecoCep" deve possuir tamanho mínimo de "8" e máximo de "10".
enderecoCidade integer
enderecoBairro alphaNumeric A propriedade "enderecoBairro" deve possuir tamanho mínimo de "3" e máximo de "80".
enderecoLogradouro alphaNumeric A propriedade "enderecoLogradouro" deve possuir tamanho mínimo de "3" e máximo de "100".
foneCelular alphaNumeric A propriedade "foneCelular" deve possuir tamanho mínimo de "8" e máximo de "16".
foneComercial alphaNumeric A propriedade "foneComercial" deve possuir tamanho mínimo de "8" e máximo de "16".
foneResidencial alphaNumeric A propriedade "foneResidencial" deve possuir tamanho mínimo de "8" e máximo de "16".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "255".
https://api.ninsaude.com/v1/cadastro_paciente

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 4743,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_paciente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_paciente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

AVISOS E BLOQUEIOS cadastro_pacientebloqueio

 
LISTAR AVISOS E BLOQUEIOS POR PACIENTE
get
cadastro_pacientebloqueio/listar/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
LISTAR SOMENTE AVISOS E BLOQUEIOS ADICIONADOS PELOS USUÁRIO
get
cadastro_pacientebloqueio/listar/adicionado/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.

 
ABRIR OBJETO
get
cadastro_pacientebloqueio/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientebloqueio/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "paciente": 11558,
        "data": "2017-11-23",
        "descricao": "rrrrrrtttttt"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_pacientebloqueio/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_pacientebloqueio/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_pacientebloqueio
put
cadastro_pacientebloqueio/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
paciente integer A propriedade "paciente" é obrigatória.
data date A propriedade "data" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "255".
https://api.ninsaude.com/v1/cadastro_pacientebloqueio

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 1126,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_pacientebloqueio/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientebloqueio/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

FAMILIARES cadastro_pacientefamilia

 
LISTAR FAMILIARES
get
cadastro_pacientefamilia/listar/familia/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_pacientefamilia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientefamilia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "pacienteOrigem": 11558,
        "pacienteDestino": 3510,
        "parentesco": 2
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_pacientefamilia/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_pacientefamilia/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_pacientefamilia
put
cadastro_pacientefamilia/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
pacienteOrigem integer A propriedade "pacienteOrigem" é obrigatória.
pacienteDestino integer A propriedade "pacienteDestino" é obrigatória.
parentesco integer A propriedade "parentesco" é obrigatória. A propriedade "parentesco" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7".
https://api.ninsaude.com/v1/cadastro_pacientefamilia

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5961,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_pacientefamilia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientefamilia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

GRUPOS DE PACIENTES cadastro_pacientegrupo

 
LISTAR GRUPOS DE PACIENTES
get
cadastro_pacientegrupo/listar

Nome Tipo Descrição
descricao string Descrição (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR GRUPOS DE PACIENTES DETALHADO
get
cadastro_pacientegrupo/listar/detalhe

Nome Tipo Descrição
descricao string Descrição (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_pacientegrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientegrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "Aaaa"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_pacientegrupo/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_pacientegrupo/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_pacientegrupo
put
cadastro_pacientegrupo/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
https://api.ninsaude.com/v1/cadastro_pacientegrupo

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 408,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_pacientegrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientegrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PACIENTES AGRUPADOS cadastro_pacientegrupoi

 
LISTAR
get
cadastro_pacientegrupoi/listar/paciente/grupo/{grupo}
get
cadastro_pacientegrupoi/listar/grupo/paciente/{paciente}

Nome Tipo Descrição
grupo integer Índice dos grupos (optional).
paciente integer Índice dos pacientes (optional).

 
ADICIONAR GRUPO EM LOTE
post
cadastro_pacientegrupoi/adicionar/lote/grupo/{grupo}

Nome Tipo Descrição
id integer
grupo integer A propriedade "grupo" é obrigatória.
paciente integer A propriedade "paciente" é obrigatória.
https://api.ninsaude.com/v1/cadastro_pacientegrupoi/adicionar/lote/grupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 7573,
    "error": []
}
 
ALTERAR GRUPO EM LOTE
put
cadastro_pacientegrupoi/alterar/lote/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
grupo array Índice dos grupos.
https://api.ninsaude.com/v1/cadastro_pacientegrupoi/alterar/lote/paciente/11558

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5677,
    "error": []
}
 
ABRIR OBJETO
get
cadastro_pacientegrupoi/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientegrupoi/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "grupo": 9,
        "paciente": 44993
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_pacientegrupoi/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_pacientegrupoi/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_pacientegrupoi
put
cadastro_pacientegrupoi/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
grupo integer A propriedade "grupo" é obrigatória.
paciente integer A propriedade "paciente" é obrigatória.
https://api.ninsaude.com/v1/cadastro_pacientegrupoi

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5026,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_pacientegrupoi/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_pacientegrupoi/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PRESCRIÇÕES cadastro_prescricao

 
LISTAR
get
cadastro_prescricao/listar

Nome Tipo Descrição
descricao string Descrição (optional).
ativo boolean Ativo (optional).
filter mixed Filtro nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_prescricao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_prescricao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "simples mesmo",
        "documento": 33,
        "ativo": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_prescricao/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_prescricao/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_prescricao
put
cadastro_prescricao/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
documento integer A propriedade "documento" é obrigatória.
ativo boolean A propriedade "ativo" é obrigatória.
https://api.ninsaude.com/v1/cadastro_prescricao

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 869,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_prescricao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_prescricao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

MEDICAMENTOS DA PRESCRIÇÃO cadastro_prescricaomedicamento

 
LISTAR
get
cadastro_prescricaomedicamento/listar

Nome Tipo Descrição
medicamento integer Medicamento (optional).
viaAdministracao mixed Vias de administração (optional).
tratamentoTipo mixed Tipos de tratamento (optional).
dosagemTipo mixed Tipos de dosagem (optional).
frequenciaTipo mixed Tipos de frequência (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_prescricaomedicamento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_prescricaomedicamento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "prescricao": 7,
        "medicamento": 63683,
        "viaAdministracao": 1,
        "tratamentoQuantidade": null,
        "tratamentoTipo": 1,
        "dosagemQuantidade": null,
        "dosagemTipo": 1,
        "frequenciaQuantidade": null,
        "frequenciaTipo": 1,
        "observacao": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_prescricaomedicamento/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_prescricaomedicamento/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_prescricaomedicamento
put
cadastro_prescricaomedicamento/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
prescricao integer A propriedade "prescricao" é obrigatória.
medicamento integer A propriedade "medicamento" é obrigatória.
viaAdministracao integer A propriedade "viaAdministracao" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17".
tratamentoQuantidade integer
tratamentoTipo integer A propriedade "tratamentoTipo" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7, 8".
dosagemQuantidade integer
dosagemTipo integer A propriedade "dosagemTipo" deve possuir um dos valores da lista "1, 2, 3, 4, 5".
frequenciaQuantidade integer
frequenciaTipo integer A propriedade "frequenciaTipo" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "250".
https://api.ninsaude.com/v1/cadastro_prescricaomedicamento

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3553,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_prescricaomedicamento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_prescricaomedicamento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PRODUTOS cadastro_produto

 
LISTAR PRODUTOS
get
cadastro_produto/listar

Nome Tipo Descrição
descricao string Descrição (optional).
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
BUSCAR QUANTIDADE DISPONÍVEL DO PRODUTO
get
cadastro_produto/buscar/quantidade/produto/{produto}

Nome Tipo Descrição
produto integer Índice do produto.

 
ABRIR OBJETO
get
cadastro_produto/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_produto/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "Energ\u00e9tico",
        "valorCusto": 3,
        "valor": 5,
        "unidade": "UN",
        "quantidade": 1020,
        "localizacao": "Geladeira",
        "ativo": 1,
        "observacao": "Energ\u00e9tico para pacientes em tratamento."
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_produto/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_produto/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_produto
put
cadastro_produto/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "100".
valorCusto decimal
valor decimal
unidade alphaNumeric
quantidade decimal
localizacao alphaNumeric
ativo boolean A propriedade "ativo" é obrigatória.
observacao alphaNumeric
https://api.ninsaude.com/v1/cadastro_produto

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9847,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_produto/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_produto/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PROFISSIONAIS DE SAÚDE cadastro_profissional

 
LISTAR PROFISSIONAIS
get
cadastro_profissional/listar

Nome Tipo Descrição
conselho mixed Índice dos conselhos (optional).
especialidade mixed Índice das especialidades (optional).
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR ASSINATURA DIGITAL
get
cadastro_profissional/abrir/assinatura/digital/profissional/{profissional}

Nome Tipo Descrição
profissional integer Índice do profissional.

 
ABRIR OBJETO
get
cadastro_profissional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "cpf": null,
        "nome": "qeqweqweqweqweqw",
        "ativo": 1,
        "email": null,
        "conselho": 2,
        "conselhoNumero": null,
        "foneCelular": null,
        "foneResidencial": null,
        "agendaCor": "328b8f",
        "agendaDuracao": 5,
        "agendaOutroHorario": 1,
        "agendaAccountUnidade": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_profissional/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_profissional/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_profissional
put
cadastro_profissional/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
cpf document A propriedade "cpf" deve possuir tamanho mínimo de "11" e máximo de "11".
nome alphaNumeric A propriedade "nome" é obrigatória. A propriedade "nome" deve possuir tamanho mínimo de "3" e máximo de "120".
ativo boolean A propriedade "ativo" é obrigatória.
email email
conselho integer A propriedade "conselho" é obrigatória.
conselhoNumero alphaNumeric A propriedade "conselhoNumero" deve possuir tamanho mínimo de "3" e máximo de "15".
foneCelular alphaNumeric A propriedade "foneCelular" deve possuir tamanho mínimo de "8" e máximo de "16".
foneResidencial alphaNumeric A propriedade "foneResidencial" deve possuir tamanho mínimo de "8" e máximo de "16".
agendaCor alphaNumeric
agendaDuracao integer A propriedade "agendaDuracao" é obrigatória.
agendaOutroHorario boolean A propriedade "agendaOutroHorario" é obrigatória.
agendaAccountUnidade alphaNumeric
https://api.ninsaude.com/v1/cadastro_profissional

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9336,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_profissional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

ESPECIALIDADES DOS PROFISSIONAIS DE SAÚDE cadastro_profissionalespecialidade

 
LISTAR ESPECIALIDADES DO PROFISSIONAL
get
cadastro_profissionalespecialidade/listar/especialidade/profissional
get
cadastro_profissionalespecialidade/listar/especialidade/profissional/{profissional}

Nome Tipo Descrição
profissional mixed Índice dos profissionais.

 
ALTERAR ESPECIALIDADES EM LOTE
put
cadastro_profissionalespecialidade/alterar/lote/{profissional}

Nome Tipo Descrição
profissional integer Índice do profissional.
especialidade array Índice das especialidades.
https://api.ninsaude.com/v1/cadastro_profissionalespecialidade/alterar/lote/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3139,
    "error": []
}
 
ABRIR OBJETO
get
cadastro_profissionalespecialidade/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalespecialidade/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "profissional": 112,
        "especialidade": 72
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_profissionalespecialidade/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_profissionalespecialidade/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_profissionalespecialidade
put
cadastro_profissionalespecialidade/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
profissional integer A propriedade "profissional" é obrigatória.
especialidade integer A propriedade "especialidade" é obrigatória.
https://api.ninsaude.com/v1/cadastro_profissionalespecialidade

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5308,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_profissionalespecialidade/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalespecialidade/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

GRUPOS DE PROFISSIONAIS cadastro_profissionalgrupo

 
LISTAR GRUPOS DE PROFISSIONAIS
get
cadastro_profissionalgrupo/listar

Nome Tipo Descrição
descricao string Descrição (optional).
ativo boolean Ativo (optional).
prontuarioCompartilhado boolean Prontuário compartilhado (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_profissionalgrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalgrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "Neuro",
        "ativo": 1,
        "prontuarioCompartilhado": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_profissionalgrupo/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_profissionalgrupo/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_profissionalgrupo
put
cadastro_profissionalgrupo/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
prontuarioCompartilhado boolean A propriedade "prontuarioCompartilhado" é obrigatória.
https://api.ninsaude.com/v1/cadastro_profissionalgrupo

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 7340,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_profissionalgrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalgrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PROFISSIONAIS DO GRUPO DE PROFISSIONAIS cadastro_profissionalgrupoprofissional

 
LISTAR PROFISSIONAIS DO GRUPO DE PROFISSIONAIS
get
cadastro_profissionalgrupoprofissional/listar
get
cadastro_profissionalgrupoprofissional/listar/grupo/{grupo}
get
cadastro_profissionalgrupoprofissional/listar/profissional/{profissional}

Nome Tipo Descrição
grupo mixed Índice dos grupos de profissionais (optional).
profissional mixed Índice dos profissionais (optional).

 
ALTERAR GRUPOS EM LOTE POR PROFISSIONAL
put
cadastro_profissionalgrupoprofissional/alterar/lote/profissional/{profissional}

Nome Tipo Descrição
profissional integer Índice do profissional.
grupo array Grupos de profissionais.
https://api.ninsaude.com/v1/cadastro_profissionalgrupoprofissional/alterar/lote/profissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 6497,
    "error": []
}
 
ABRIR OBJETO
get
cadastro_profissionalgrupoprofissional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalgrupoprofissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "grupo": 7,
        "profissional": 107
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_profissionalgrupoprofissional/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_profissionalgrupoprofissional/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_profissionalgrupoprofissional
put
cadastro_profissionalgrupoprofissional/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
grupo integer A propriedade "grupo" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
https://api.ninsaude.com/v1/cadastro_profissionalgrupoprofissional

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 6156,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_profissionalgrupoprofissional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalgrupoprofissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

GRADE DE HORÁRIO DOS PROFISSIONAIS DE SAÚDE cadastro_profissionalhorario

 
LISTAR GRADE DE HORÁRIO DOS PROFISSIONAIS DE SAÚDE
get
cadastro_profissionalhorario/listar/profissional
get
cadastro_profissionalhorario/listar/profissional/{profissional}

Nome Tipo Descrição
profissional mixed Índice dos profissionais.

 
BUSCAR UNIDADE DE ATENDIMENTO DAS CONFIGURAÇÕES DO PROFISSIONAL
get
cadastro_profissionalhorario/buscar/unidade/profissional/{profissional}/data/{data}/horaInicial/{horaInicial}/horaFinal/{horaFinal}

Nome Tipo Descrição
profissional integer Índice do profissional.
data string Data do agendamento.
horaInicial string Hora inicial do agendamento.
horaFinal string Hora final do agendamento.

Notice: Undefined index: {horaInicial} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347

Notice: Undefined index: {horaFinal} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
 
ABRIR OBJETO
get
cadastro_profissionalhorario/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalhorario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "profissional": 112,
        "diaSemana": 5,
        "horaInicial": "14:00:00",
        "horaFinal": "18:00:00"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_profissionalhorario/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_profissionalhorario/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_profissionalhorario
put
cadastro_profissionalhorario/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
diaSemana integer A propriedade "diaSemana" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7".
horaInicial time A propriedade "horaInicial" é obrigatória.
horaFinal time A propriedade "horaFinal" é obrigatória.
https://api.ninsaude.com/v1/cadastro_profissionalhorario

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 7132,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_profissionalhorario/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalhorario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

CONFIGURAÇÃO DE CARD DO PRONTUÁRIO cadastro_profissionalprontuariocard

 
LISTAR
get
cadastro_profissionalprontuariocard/listar/profissional/{profissional}
get
cadastro_profissionalprontuariocard/listar/profissional/{profissional}/tipo/{tipo}

Nome Tipo Descrição
profissional integer Índice do profissional.
tipo mixed Tipo (optional).

 
ABRIR OBJETO
get
cadastro_profissionalprontuariocard/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalprontuariocard/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "profissional": 1,
        "tipo": 3,
        "posicao": 2,
        "opcao": "{}"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_profissionalprontuariocard/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_profissionalprontuariocard/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_profissionalprontuariocard
put
cadastro_profissionalprontuariocard/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
profissional integer A propriedade "profissional" é obrigatória.
tipo integer A propriedade "tipo" é obrigatória. A propriedade "tipo" deve possuir valor mínimo de "1" e máximo de "9".
posicao integer A propriedade "posicao" é obrigatória. A propriedade "posicao" deve possuir valor mínimo de "1" e máximo de "4".
opcao alphaNumeric A propriedade "opcao" é obrigatória. A propriedade "opcao" deve possuir tamanho mínimo de "2" e máximo de "200".
https://api.ninsaude.com/v1/cadastro_profissionalprontuariocard

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3584,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_profissionalprontuariocard/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalprontuariocard/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

CONFIGURAÇÃO DE MENU DO PRONTUÁRIO cadastro_profissionalprontuariomenu

 
LISTAR
get
cadastro_profissionalprontuariomenu/listar/profissional/{profissional}

Nome Tipo Descrição
profissional integer Índice do profissional.

 
ALTERAR EM LOTES
put
cadastro_profissionalprontuariomenu/alterar/lote/profissional/{profissional}

Nome Tipo Descrição
profissional integer Índice do profissional.
menu array Menus.
https://api.ninsaude.com/v1/cadastro_profissionalprontuariomenu/alterar/lote/profissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2819,
    "error": []
}
 
ABRIR OBJETO
get
cadastro_profissionalprontuariomenu/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalprontuariomenu/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "profissional": 1,
        "menu": 5
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_profissionalprontuariomenu/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_profissionalprontuariomenu/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_profissionalprontuariomenu
put
cadastro_profissionalprontuariomenu/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
profissional integer A propriedade "profissional" é obrigatória.
menu integer A propriedade "menu" é obrigatória. A propriedade "menu" deve possuir um dos valores da lista "1, 2, 3, 4, 5".
https://api.ninsaude.com/v1/cadastro_profissionalprontuariomenu

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 1932,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_profissionalprontuariomenu/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_profissionalprontuariomenu/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

SERVIÇOS cadastro_servico

 
LISTAR SERVIÇOS
get
cadastro_servico/listar

Nome Tipo Descrição
descricao string Descrição (optional).
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR SERVIÇOS COMUNS
get
cadastro_servico/listar/comum

Nome Tipo Descrição
descricao string Descrição (optional).
ativo boolean Ativo (optional).
paciente integer Índice do paciente (optional).
profissional integer Índice do profissional (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR SERVIÇOS E VALORES DOS AGENDAMENTOS
get
cadastro_servico/listar/valor/servico/agendamento
get
cadastro_servico/listar/valor/servico/agendamento/{agendamento}

Nome Tipo Descrição
agendamento mixed Índice dos agendamentos.

 
BUSCAR DURAÇÃO DO SERVIÇO
get
cadastro_servico/buscar/duracao/servico/{servico}

Nome Tipo Descrição
servico integer Índice do servico.

 
ABRIR OBJETO
get
cadastro_servico/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servico/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "Evolu\u00e3\u00a7\u00e3\u00a3o Smart",
        "ativo": 1,
        "tissTipo": null,
        "tissTipoGuia": null,
        "tissTipoAtendimento": null,
        "valorPadrao": 0,
        "duracaoPadrao": 0,
        "grupo": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_servico/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_servico/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_servico
put
cadastro_servico/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
tissTipo integer A propriedade "tissTipo" deve possuir um dos valores da lista "1, 2, 3, 4".
tissTipoGuia integer A propriedade "tissTipoGuia" deve possuir um dos valores da lista "1, 2, 3".
tissTipoAtendimento integer
valorPadrao decimal
duracaoPadrao integer
grupo integer
https://api.ninsaude.com/v1/cadastro_servico

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5546,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_servico/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servico/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

COMISSÃO DOS PROFISSIONAIS DE SAÚDE cadastro_servicocomissao

 
LISTAR COMISSÃO DOS PROFISSIONAIS DE SAÚDE
get
cadastro_servicocomissao/listar

Nome Tipo Descrição
servico mixed Índice dos serviços (optional).
convenio mixed Índice dos convênios (optional).
profissional mixed Índice dos profissionais (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_servicocomissao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servicocomissao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "servico": 81,
        "profissional": 51,
        "convenio": 143,
        "convenioPlano": 42,
        "tipo": 0,
        "comissao": 0.44
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_servicocomissao/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_servicocomissao/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_servicocomissao
put
cadastro_servicocomissao/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
servico integer A propriedade "servico" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
convenio integer
convenioPlano integer
tipo integer A propriedade "tipo" é obrigatória.
comissao decimal A propriedade "comissao" é obrigatória.
https://api.ninsaude.com/v1/cadastro_servicocomissao

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 4500,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_servicocomissao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servicocomissao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

VALORIZAÇÃO DE SERVIÇOS POR CONVÊNIOS E PLANOS cadastro_servicoconvenio

 
LISTAR VALORIZAÇÕES DE SERVIÇOS POR CONVÊNIO E PLANOS
get
cadastro_servicoconvenio/listar
get
cadastro_servicoconvenio/listar/servico/{servico}
get
cadastro_servicoconvenio/listar/convenio/{convenio}

Nome Tipo Descrição
servico mixed Índice dos serviços (optional).
convenio mixed Índice dos convênios (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_servicoconvenio/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servicoconvenio/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "servico": 52,
        "convenio": 13,
        "convenioPlano": 18,
        "tabela": 18,
        "procedimento": 31050,
        "procedimentoCodigo": null,
        "procedimentoDescricao": null,
        "procedimentoQuantidade": 1,
        "categoria": 10,
        "categoriaSub": 24,
        "conta": 2,
        "tipoPagto": 25,
        "pagoParticular": 1,
        "pagoConvenio": 1,
        "valorConvenio": 22.22,
        "valorParticular": 3333.33
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_servicoconvenio/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_servicoconvenio/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_servicoconvenio
put
cadastro_servicoconvenio/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
servico integer A propriedade "servico" é obrigatória.
convenio integer A propriedade "convenio" é obrigatória.
convenioPlano integer
tabela integer
procedimento integer
procedimentoCodigo alphaNumeric
procedimentoDescricao alphaNumeric
procedimentoQuantidade integer A propriedade "procedimentoQuantidade" é obrigatória.
categoria integer
categoriaSub integer
conta integer
tipoPagto integer
pagoParticular boolean A propriedade "pagoParticular" é obrigatória.
pagoConvenio boolean A propriedade "pagoConvenio" é obrigatória.
valorConvenio decimal
valorParticular decimal
https://api.ninsaude.com/v1/cadastro_servicoconvenio

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 190,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_servicoconvenio/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servicoconvenio/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

GRUPOS DE SERVIÇO cadastro_servicogrupo

 
LISTAR GRUPOS DE SERVIÇOS
get
cadastro_servicogrupo/listar

Nome Tipo Descrição
descricao string Descrição (optional).
tipo mixed Tipo de grupo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_servicogrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servicogrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "Hospitalares",
        "tipo": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_servicogrupo/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_servicogrupo/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_servicogrupo
put
cadastro_servicogrupo/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
tipo integer A propriedade "tipo" é obrigatória.
https://api.ninsaude.com/v1/cadastro_servicogrupo

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 4950,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_servicogrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_servicogrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

TIPOS DE PAGAMENTO cadastro_tipopagto

 
LISTAR TIPOS DE PAGAMENTO
get
cadastro_tipopagto/listar

Nome Tipo Descrição
descricao string Descrição (optional).
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_tipopagto/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_tipopagto/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "ewqweqwe",
        "ativo": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_tipopagto/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_tipopagto/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_tipopagto
put
cadastro_tipopagto/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
https://api.ninsaude.com/v1/cadastro_tipopagto

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8076,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_tipopagto/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_tipopagto/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

USUÁRIOS cadastro_usuario

 
LISTAR USUÁRIOS
get
cadastro_usuario/listar

Nome Tipo Descrição
nome string Nome (optional).
login string Login (optional).
ativo boolean Ativo (optional).
administrador boolean Usuário administrador (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR ANIVERSARIANTES
get
cadastro_usuario/listar/aniversariante/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.

 
ABRIR OBJETO
get
cadastro_usuario/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "login": "jonas",
        "nome": "jonas",
        "ativo": 1,
        "nivel": 1,
        "profissional": null,
        "email": "jonas@ninsaude.com",
        "dataNascimento": null,
        "grupo": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_usuario/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_usuario/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_usuario
put
cadastro_usuario/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
login alphaNumeric A propriedade "login" é obrigatória. A propriedade "login" deve possuir tamanho mínimo de "4" e máximo de "45".
senha required A propriedade "senha" deve possuir tamanho mínimo de "8" e máximo de "45".
senhaHash alphaNumeric A propriedade "senhaHash" deve possuir tamanho mínimo de "8" e máximo de "60".
nome alphaNumeric A propriedade "nome" é obrigatória. A propriedade "nome" deve possuir tamanho mínimo de "3" e máximo de "120".
ativo boolean A propriedade "ativo" é obrigatória.
nivel integer A propriedade "nivel" é obrigatória. A propriedade "nivel" deve possuir um dos valores da lista "1, 2".
profissional integer
email email A propriedade "email" é obrigatória.
dataNascimento date
senhaRecuperar alphaNumeric A propriedade "senhaRecuperar" deve possuir tamanho mínimo de "3" e máximo de "45".
senhaRecuperarPrazo datetime
grupo integer
https://api.ninsaude.com/v1/cadastro_usuario

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 6310,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_usuario/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

GRUPOS DE USUÁRIOS cadastro_usuariogrupo

 
LISTAR GRUPOS DE USUÁRIOS
get
cadastro_usuariogrupo/listar

Nome Tipo Descrição
descricao string Descrição (optional).
ativo boolean Ativo (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_usuariogrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuariogrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "fof",
        "ativo": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_usuariogrupo/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_usuariogrupo/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_usuariogrupo
put
cadastro_usuariogrupo/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
https://api.ninsaude.com/v1/cadastro_usuariogrupo

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2339,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_usuariogrupo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuariogrupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

RESTRIÇÕES POR GRUPO DE USUÁRIOS cadastro_usuariogruporestricao

 
LISTAR RESTRIÇÕES
get
cadastro_usuariogruporestricao/listar
get
cadastro_usuariogruporestricao/listar/grupo/{grupo}
get
cadastro_usuariogruporestricao/listar/recurso/{recurso}

Nome Tipo Descrição
grupo mixed Índice dos grupos (optional).
recurso mixed Índice dos recursos (optional).
tipo string Tipo (optional).

 
ALTERAR RESTRIÇÕES EM LOTE
put
cadastro_usuariogruporestricao/alterar/lote/grupo/{grupo}

Nome Tipo Descrição
grupo integer Índice do grupo.
restricao array Restrições compostas por recurso e tipo.
https://api.ninsaude.com/v1/cadastro_usuariogruporestricao/alterar/lote/grupo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 7166,
    "error": []
}
 
ABRIR OBJETO
get
cadastro_usuariogruporestricao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuariogruporestricao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_usuariogruporestricao/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_usuariogruporestricao/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_usuariogruporestricao
put
cadastro_usuariogruporestricao/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
grupo integer A propriedade "grupo" é obrigatória.
recurso alphaNumeric A propriedade "recurso" é obrigatória. A propriedade "recurso" deve possuir tamanho mínimo de "3" e máximo de "45".
tipo required
https://api.ninsaude.com/v1/cadastro_usuariogruporestricao

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2096,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_usuariogruporestricao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuariogruporestricao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

UNIDADES DE ATENDIMENTO DOS USUÁRIOS cadastro_usuariounidade

 
LISTA AS UNIDADES
get
cadastro_usuariounidade/listar

Nome Tipo Descrição
usuario mixed Índice dos usuários (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
cadastro_usuariounidade/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuariounidade/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
cadastro_usuariounidade/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
cadastro_usuariounidade/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
cadastro_usuariounidade
put
cadastro_usuariounidade/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
usuario integer Você não possui privilégios de administrador. A propriedade "usuario" é obrigatória.
unidade integer A propriedade "unidade" é obrigatória.
https://api.ninsaude.com/v1/cadastro_usuariounidade

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8664,
    "error": []
}
 
EXCLUIR OBJETO
delete
cadastro_usuariounidade/{id:^[0-9]++$}

https://api.ninsaude.com/v1/cadastro_usuariounidade/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

COMISSÃO DOS PROFISSIONAIS fluxo_comissaoprofissional

 
LISTAR RESUMO DE COMISSIONAMENTO
get
fluxo_comissaoprofissional/listar/resumo/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
profissional array Índices dos profissionais (optional).
servico array Índices dos serviços (optional).
convenio array Índices dos convênios (optional).
encaminhador array Índices dos encaminhadores (optional).
accountUnidade array Índices das unidades (optional).
status array Status (optional).

 
LISTAR COMISSIONAMENTO DETALHADO POR PROFISSIONAL
get
fluxo_comissaoprofissional/listar/detalhe/profissional/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
profissional array Índices dos profissionais (optional).
servico array Índices dos serviços (optional).
convenio array Índices dos convênios (optional).
encaminhador array Índices dos encaminhadores (optional).
accountUnidade array Índices das unidades (optional).
status array Status (optional).

 
LISTAR COMISSIONAMENTO DETALHADO POR CLÍNICA E PROFISSIONAL
get
fluxo_comissaoprofissional/listar/detalhe/clinica/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
profissional array Índices dos profissionais (optional).
servico array Índices dos serviços (optional).
convenio array Índices dos convênios (optional).
encaminhador array Índices dos encaminhadores (optional).
accountUnidade array Índices das unidades (optional).
status array Status (optional).

 
ADICIONAR COMISSÕES EM LOTE
post
fluxo_comissaoprofissional/adicionar/lote

Nome Tipo Descrição
id integer
agendamento integer A propriedade "agendamento" é obrigatória.
agendamentoServicoAdicional integer
despesa integer A propriedade "despesa" é obrigatória.
https://api.ninsaude.com/v1/fluxo_comissaoprofissional/adicionar/lote

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3196,
    "error": []
}
 
ABRIR OBJETO
get
fluxo_comissaoprofissional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_comissaoprofissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "agendamento": 127808,
        "agendamentoServicoAdicional": 1256,
        "despesa": 668
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_comissaoprofissional/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_comissaoprofissional/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_comissaoprofissional
put
fluxo_comissaoprofissional/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
agendamento integer A propriedade "agendamento" é obrigatória.
agendamentoServicoAdicional integer
despesa integer A propriedade "despesa" é obrigatória.
https://api.ninsaude.com/v1/fluxo_comissaoprofissional

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 6786,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_comissaoprofissional/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_comissaoprofissional/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

CONTAS BANCÁRIAS fluxo_conta

 
LISTAR CONTAS BANCÁRIAS
get
fluxo_conta/listar

Nome Tipo Descrição
ativo boolean Ativo (optional).
descricao string Descrição (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
fluxo_conta/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_conta/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "descricao": "Offshore P 3",
        "ativo": 1,
        "saldoInicial": 0,
        "valorLimite": 0,
        "saldoAtual": 0
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_conta/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_conta/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_conta
put
fluxo_conta/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "45".
ativo boolean A propriedade "ativo" é obrigatória.
saldoInicial decimal A propriedade "saldoInicial" é obrigatória.
valorLimite decimal A propriedade "valorLimite" é obrigatória.
saldoAtual decimal A propriedade "saldoAtual" é obrigatória.
https://api.ninsaude.com/v1/fluxo_conta

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8997,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_conta/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_conta/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

DESPESAS fluxo_despesa

 
LISTAR DESPESAS
get
fluxo_despesa/listar
get
fluxo_despesa/listar/duplicata/referencia/{referencia}

Nome Tipo Descrição
status integer Status (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).
conta mixed Índice das contas bancárias (optional).
tipoPagamento mixed Índice dos tipos de pagamento (optional).
fornecedor mixed Índice dos fornecedores (optional).
dataVencimentoInicial string Data de vencimento inicial (optional).
dataVencimentoFinal string Data de vencimento final (optional).
dataPagamentoInicial string Data de pagamento inicial (optional).
dataPagamentoFinal string Data de pagamento final (optional).
dataEmissaoInicial string Data de emissão inicial (optional).
dataEmissaoFinal string Data de emissão final (optional).
referencia integer Índice da referência (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR VALOR TOTAL QUITADO
get
fluxo_despesa/listar/quitado/ano/{anoInicial}
get
fluxo_despesa/listar/quitado/anoInicial/{anoInicial}/anoFinal/{anoFinal}
get
fluxo_despesa/listar/quitado/ano/{anoInicial}/categoria/{categoria}
get
fluxo_despesa/listar/quitado/anoInicial/{anoInicial}/anoFinal/{anoFinal}/categoria/{categoria}
get
fluxo_despesa/listar/quitado/ano/{anoInicial}/categoriaSub/{categoriaSub}
get
fluxo_despesa/listar/quitado/anoInicial/{anoInicial}/anoFinal/{anoFinal}/categoriaSub/{categoriaSub}

Nome Tipo Descrição
anoInicial integer Ano inicial.
anoFinal integer Ano final (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).

 
VERIFICAR TIPO DE DESPESA
get
fluxo_despesa/verificar/tipo/despesa/{despesa}

Nome Tipo Descrição
despesa integer Índice da despesa.

 
MARCAR DESPESAS COMO PAGO OU NÃO PAGO
put
fluxo_despesa/marcar/pago
put
fluxo_despesa/marcar/pago/despesa/{despesa}

Nome Tipo Descrição
pago boolean Pago.
despesa mixed Índice das despesas.
https://api.ninsaude.com/v1/fluxo_despesa/marcar/pago

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5609,
    "error": []
}
 
CRIAR DUPLICATAS
post
fluxo_despesa/criar/duplicata/despesa/{despesa}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
referencia integer
fornecedor integer
conta integer A propriedade "conta" é obrigatória.
pago boolean A propriedade "pago" é obrigatória.
categoria integer A propriedade "categoria" é obrigatória.
categoriaSub integer
tipoPagto integer A propriedade "tipoPagto" é obrigatória.
dataVencto date A propriedade "dataVencto" é obrigatória.
dataEmissao date A propriedade "dataEmissao" é obrigatória.
dataPagamento date
valor decimal A propriedade "valor" é obrigatória.
valorTotal decimal A propriedade "valorTotal" é obrigatória.
valorJuros decimal
valorMulta decimal
valorOutros decimal
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
observacao alphaNumeric
https://api.ninsaude.com/v1/fluxo_despesa/criar/duplicata/despesa/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8221,
    "error": []
}
 
ABRIR OBJETO
get
fluxo_despesa/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_despesa/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "referencia": null,
        "fornecedor": null,
        "conta": 2,
        "pago": 1,
        "categoria": 22,
        "categoriaSub": null,
        "tipoPagto": 27,
        "dataVencto": "2017-11-03",
        "dataEmissao": "2017-11-03",
        "dataPagamento": "2017-11-03",
        "valor": 500,
        "valorTotal": 500,
        "valorJuros": null,
        "valorMulta": null,
        "valorOutros": null,
        "documento": "Transfer\u00eancia de 500,00 feita em 03\/11\/2017 com descri\u00e7\u00e3o: .",
        "observacao": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_despesa/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_despesa/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_despesa
put
fluxo_despesa/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
referencia integer
fornecedor integer
conta integer A propriedade "conta" é obrigatória.
pago boolean A propriedade "pago" é obrigatória.
categoria integer A propriedade "categoria" é obrigatória.
categoriaSub integer
tipoPagto integer A propriedade "tipoPagto" é obrigatória.
dataVencto date A propriedade "dataVencto" é obrigatória.
dataEmissao date A propriedade "dataEmissao" é obrigatória.
dataPagamento date
valor decimal A propriedade "valor" é obrigatória.
valorTotal decimal A propriedade "valorTotal" é obrigatória.
valorJuros decimal
valorMulta decimal
valorOutros decimal
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
observacao alphaNumeric
https://api.ninsaude.com/v1/fluxo_despesa

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9070,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_despesa/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_despesa/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

DESPESAS RECORRENTES fluxo_despesarecorrente

 
LISTAR TÍTULOS RECORRENTES
get
fluxo_despesarecorrente/listar
get
fluxo_despesarecorrente/listar/repetir/dataInicial/inicial/{repetirDataInicialInicial}/final/{repetirDataInicialFinal}

Nome Tipo Descrição
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).
conta mixed Índice das contas bancárias (optional).
tipoPagamento mixed Índice dos tipos de pagamento (optional).
fornecedor mixed Índice dos fornecedores (optional).
repetirDataInicialInicial string Repetir data inicial inicial (optional).
repetirDataInicialFinal string Repetir data inicial final (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
fluxo_despesarecorrente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_despesarecorrente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "fornecedor": 27,
        "conta": 11,
        "categoria": 12,
        "categoriaSub": null,
        "tipoPagamento": 25,
        "valor": 66.66,
        "valorTotal": 66.66,
        "documento": null,
        "observacao": null,
        "repetirDataInicial": "2017-02-15",
        "repetirDataFinal": null,
        "repetirIntervaloDia": null,
        "repetirAno": null,
        "repetirMes": null,
        "repetirDia": 15,
        "repetirSemanaAno": null,
        "repetirSemanaMes": null,
        "repetirSemanaDia": null,
        "repetirNumeroOcorrencia": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_despesarecorrente/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_despesarecorrente/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_despesarecorrente
put
fluxo_despesarecorrente/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
fornecedor integer
conta integer A propriedade "conta" é obrigatória.
categoria integer A propriedade "categoria" é obrigatória.
categoriaSub integer
tipoPagamento integer A propriedade "tipoPagamento" é obrigatória.
valor decimal A propriedade "valor" é obrigatória.
valorTotal decimal A propriedade "valorTotal" é obrigatória.
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "500".
repetirDataInicial date A propriedade "repetirDataInicial" é obrigatória.
repetirDataFinal date
repetirIntervaloDia integer A propriedade "repetirIntervaloDia" deve possuir valor compatível com a expressão "repetirIntervaloDia > 0".
repetirAno integer A propriedade "repetirAno" deve possuir valor mínimo de "1980" e máximo de "2100".
repetirMes integer A propriedade "repetirMes" deve possuir valor mínimo de "1" e máximo de "12".
repetirDia integer A propriedade "repetirDia" deve possuir valor mínimo de "1" e máximo de "31".
repetirSemanaAno integer A propriedade "repetirSemanaAno" deve possuir valor mínimo de "1" e máximo de "52".
repetirSemanaMes integer A propriedade "repetirSemanaMes" deve possuir valor mínimo de "1" e máximo de "5".
repetirSemanaDia integer A propriedade "repetirSemanaDia" deve possuir valor mínimo de "1" e máximo de "7".
repetirNumeroOcorrencia integer A propriedade "repetirNumeroOcorrencia" deve possuir valor compatível com a expressão "repetirNumeroOcorrencia > 0".
https://api.ninsaude.com/v1/fluxo_despesarecorrente

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8408,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_despesarecorrente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_despesarecorrente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

DESPESAS RECORRENTES fluxo_despesarecorrenteocorrencia

 
LISTAR OCORRÊNCIAS
get
fluxo_despesarecorrenteocorrencia/listar/despesaRecorrente/{despesaRecorrente:^[0-9]++$}
get
fluxo_despesarecorrenteocorrencia/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
despesaRecorrente mixed Índice das despesas recorrentes (optional).
status mixed Status das ocorrências (optional).
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
BUSCAR DESPESA DA OCORRÊNCIA
get
fluxo_despesarecorrenteocorrencia/buscar/despesa/despesaRecorrente/{despesaRecorrente:^[0-9]++$}/data/{data}

Nome Tipo Descrição
despesaRecorrente integer Índice da despesa recorrente.
data string Data da ocorrência.

 
ADICIONAR OCORRÊNCIA DO TIPO TÍTULO
post
fluxo_despesarecorrenteocorrencia/adicionar/titulo/despesaRecorrente/{despesaRecorrente}

Nome Tipo Descrição
id integer
despesaRecorrente integer A propriedade "despesaRecorrente" é obrigatória.
status integer A propriedade "status" é obrigatória.
data date A propriedade "data" é obrigatória.
despesa integer

Notice: Undefined index: {despesaRecorrente} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/fluxo_despesarecorrenteocorrencia/adicionar/titulo/despesaRecorrente/ Content-type: application/json Authorization: bearer <<access_token>> { "result": 1431, "error": [] }
 
ABRIR OBJETO
get
fluxo_despesarecorrenteocorrencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_despesarecorrenteocorrencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "despesaRecorrente": 8,
        "status": 0,
        "data": "2017-05-04",
        "despesa": 641
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_despesarecorrenteocorrencia/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_despesarecorrenteocorrencia/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_despesarecorrenteocorrencia
put
fluxo_despesarecorrenteocorrencia/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
despesaRecorrente integer A propriedade "despesaRecorrente" é obrigatória.
status integer A propriedade "status" é obrigatória.
data date A propriedade "data" é obrigatória.
despesa integer
https://api.ninsaude.com/v1/fluxo_despesarecorrenteocorrencia

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9775,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_despesarecorrenteocorrencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_despesarecorrenteocorrencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

FLUXO DE CAIXA fluxo_fluxocaixa

 
LISTAR FLUXO DE CAIXA
get
fluxo_fluxocaixa/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade mixed Índice das unidades de atendimento (optional).
conta mixed Índice das contas bancárias (optional).

 

RECEITAS E DESPESAS fluxo_geral

 
LISTAR
get
fluxo_geral/listar
get
fluxo_geral/listar/vencimento/dataInicial/{dataVencimentoInicial}/dataFinal/{dataVencimentoFinal}
get
fluxo_geral/listar/pagamento/dataInicial/{dataPagamentoInicial}/dataFinal/{dataPagamentoFinal}
get
fluxo_geral/listar/emissao/dataInicial/{dataEmissaoInicial}/dataFinal/{dataEmissaoFinal}

Nome Tipo Descrição
tipo integer Tipo (optional).
status integer Status (optional).
dataVencimentoInicial string Data de vencimento inicial (optional).
dataVencimentoFinal string Data de vencimento final (optional).
dataPagamentoInicial string Data de pagamento inicial (optional).
dataPagamentoFinal string Data de pagamento final (optional).
dataEmissaoInicial string Data de emissão inicial (optional).
dataEmissaoFinal string Data de emissão final (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).
conta mixed Índice das contas bancárias (optional).
tipoPagamento mixed Índice dos tipos de pagamento (optional).
convenio mixed Índice dos convênios (optional).
servico mixed Índice dos serviços (optional).
profissional mixed Índice dos profissionais (optional).
fornecedor mixed Índice dos fornecedores (optional).
paciente mixed Índice dos pacientes (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 

GRÁFICOS DE FINANÇAS fluxo_grafico

 
FLUXO DE CAIXA POR PERÍODO
get
fluxo_grafico/listar/fluxoCaixa/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
INADIMPLÊNCIA POR PERÍODO
get
fluxo_grafico/listar/inadimplencia/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VALORES TRANSACIONADOS POR TIPO DE PAGAMENTO E PERÍODO
get
fluxo_grafico/listar/tipoDePagamento/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VALORES TRANSACIONADOS POR CATEGORIAS DE RECEITA E PERÍODO
get
fluxo_grafico/listar/categoria/receita/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VALORES TRANSACIONADOS POR CATEGORIAS DE DESPESA E PERÍODO
get
fluxo_grafico/listar/categoria/despesa/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VALORES TRANSACIONADOS POR CONTA BANCÁRIA E PERÍODO
get
fluxo_grafico/listar/conta/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VALORES TRANSACIONADOS POR SERVIÇO E PERÍODO
get
fluxo_grafico/listar/servico/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VALORES TRANSACIONADOS POR CONVÊNIOS E PERÍODO
get
fluxo_grafico/listar/convenio/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VALORES TRANSACIONADOS POR PROFISSIONAL E PERÍODO
get
fluxo_grafico/listar/profissional/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
STATUS DAS RECEITAS POR PERÍODO
get
fluxo_grafico/listar/status/receita/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
STATUS DAS DESPESAS POR PERÍODO
get
fluxo_grafico/listar/status/despesa/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
PREVISÃO DO PAYBACK MENSAL
get
fluxo_grafico/listar/payback/mensal/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
TICKET MÉDIO MENSAL POR PACIENTE
get
fluxo_grafico/listar/ticketMedio/paciente/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
RESULTADO FINANCEIRO DOS ÚLTIMOS ANOS
get
fluxo_grafico/listar/balanco/anual/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 

RECEITAS fluxo_receita

 
LISTAR RECEITAS
get
fluxo_receita/listar
get
fluxo_receita/listar/duplicata/referencia/{referencia}
get
fluxo_receita/listar/agendamento/{agendamento}
get
fluxo_receita/listar/paciente/{paciente}

Nome Tipo Descrição
status integer Status (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).
conta mixed Índice das contas bancárias (optional).
tipoPagamento mixed Índice dos tipos de pagamento (optional)..
convenio mixed Índice dos convênios (optional).
servico mixed Índice dos serviços (optional).
profissional mixed Índice do profissionais (optional).
paciente mixed Índice do pacientes (optional).
agendamento mixed Índice dos agendamentos (optional).
dataVencimentoInicial string Data de vencimento inicial (optional).
dataVencimentoFinal string Data de vencimento final (optional).
dataPagamentoInicial string Data de pagamento inicial (optional).
dataPagamentoFinal string Data de pagamento final (optional).
dataEmissaoInicial string Data de emissão inicial (optional).
dataEmissaoFinal string Data de emissão final (optional).
referencia integer Índice da referência (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR VALOR TOTAL QUITADO
get
fluxo_receita/listar/quitado/ano/{anoInicial}
get
fluxo_receita/listar/quitado/anoInicial/{anoInicial}/anoFinal/{anoFinal}
get
fluxo_receita/listar/quitado/ano/{anoInicial}/categoria/{categoria}
get
fluxo_receita/listar/quitado/anoInicial/{anoInicial}/anoFinal/{anoFinal}/categoria/{categoria}
get
fluxo_receita/listar/quitado/ano/{anoInicial}/categoriaSub/{categoriaSub}
get
fluxo_receita/listar/quitado/anoInicial/{anoInicial}/anoFinal/{anoFinal}/categoriaSub/{categoriaSub}

Nome Tipo Descrição
anoInicial integer Ano inicial.
anoFinal integer Ano final (optional).
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).

 
VERIFICAR TIPO DE RECEITA
get
fluxo_receita/verificar/tipo/receita/{receita}

Nome Tipo Descrição
receita integer Índice da receita.

 
MARCAR RECEITAS COMO PAGO OU NÃO PAGO
put
fluxo_receita/marcar/pago
put
fluxo_receita/marcar/pago/receita/{receita}

Nome Tipo Descrição
pago boolean Pago.
receita mixed Índice das receitas.
https://api.ninsaude.com/v1/fluxo_receita/marcar/pago

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8811,
    "error": []
}
 
CRIAR DUPLICATAS
post
fluxo_receita/criar/duplicata/receita/{receita}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
referencia integer
paciente integer
conta integer A propriedade "conta" é obrigatória.
pago boolean A propriedade "pago" é obrigatória.
recibo integer A propriedade "recibo" é obrigatória.
categoria integer A propriedade "categoria" é obrigatória.
categoriaSub integer
tipoPagto integer A propriedade "tipoPagto" é obrigatória.
dataVencto date A propriedade "dataVencto" é obrigatória.
dataEmissao date A propriedade "dataEmissao" é obrigatória.
dataPagamento date
dataRecibo date
valor decimal A propriedade "valor" é obrigatória.
valorTotal decimal A propriedade "valorTotal" é obrigatória.
valorJuros decimal
valorMulta decimal
valorOutros decimal
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
agendamento integer
agendamentoProfissional integer
agendamentoServicoAdicional integer
tissConsultaLote integer
tissSadtLote integer
tissHonorarioLote integer
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "500".
pagadorTipo boolean
pagadorDescricao alphaNumeric A propriedade "pagadorDescricao" deve possuir tamanho mínimo de "3" e máximo de "120".
pagadorDocumento document A propriedade "pagadorDocumento" deve possuir tamanho mínimo de "3" e máximo de "14".
https://api.ninsaude.com/v1/fluxo_receita/criar/duplicata/receita/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 6445,
    "error": []
}
 
ABRIR OBJETO
get
fluxo_receita/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_receita/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "referencia": null,
        "paciente": 11558,
        "conta": 7,
        "pago": 1,
        "recibo": 0,
        "categoria": 5,
        "categoriaSub": null,
        "tipoPagto": 7,
        "dataVencto": "2017-10-01",
        "dataEmissao": "2017-11-23",
        "dataPagamento": "2017-11-23",
        "dataRecibo": "2017-11-23",
        "valor": 2,
        "valorTotal": 2,
        "valorJuros": null,
        "valorMulta": null,
        "valorOutros": null,
        "documento": "recorrer",
        "agendamento": null,
        "agendamentoProfissional": null,
        "agendamentoServicoAdicional": null,
        "tissConsultaLote": null,
        "tissSadtLote": null,
        "tissHonorarioLote": null,
        "observacao": "ttt",
        "pagadorTipo": 0,
        "pagadorDescricao": null,
        "pagadorDocumento": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_receita/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_receita/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_receita
put
fluxo_receita/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
referencia integer
paciente integer
conta integer A propriedade "conta" é obrigatória.
pago boolean A propriedade "pago" é obrigatória.
recibo integer A propriedade "recibo" é obrigatória.
categoria integer A propriedade "categoria" é obrigatória.
categoriaSub integer
tipoPagto integer A propriedade "tipoPagto" é obrigatória.
dataVencto date A propriedade "dataVencto" é obrigatória.
dataEmissao date A propriedade "dataEmissao" é obrigatória.
dataPagamento date
dataRecibo date
valor decimal A propriedade "valor" é obrigatória.
valorTotal decimal A propriedade "valorTotal" é obrigatória.
valorJuros decimal
valorMulta decimal
valorOutros decimal
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
agendamento integer
agendamentoProfissional integer
agendamentoServicoAdicional integer
tissConsultaLote integer
tissSadtLote integer
tissHonorarioLote integer
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "500".
pagadorTipo boolean
pagadorDescricao alphaNumeric A propriedade "pagadorDescricao" deve possuir tamanho mínimo de "3" e máximo de "120".
pagadorDocumento document A propriedade "pagadorDocumento" deve possuir tamanho mínimo de "3" e máximo de "14".
https://api.ninsaude.com/v1/fluxo_receita

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 7767,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_receita/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_receita/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 
ABRIR OBJETOS EM PILHA
get
fluxo_receita/bulk/id/{id}

https://api.ninsaude.com/v1/fluxo_receita/bulk/id/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "referencia": null,
        "paciente": 11558,
        "conta": 7,
        "pago": 1,
        "recibo": 0,
        "categoria": 5,
        "categoriaSub": null,
        "tipoPagto": 7,
        "dataVencto": "2017-10-01",
        "dataEmissao": "2017-11-23",
        "dataPagamento": "2017-11-23",
        "dataRecibo": "2017-11-23",
        "valor": 2,
        "valorTotal": 2,
        "valorJuros": null,
        "valorMulta": null,
        "valorOutros": null,
        "documento": "recorrer",
        "agendamento": null,
        "agendamentoProfissional": null,
        "agendamentoServicoAdicional": null,
        "tissConsultaLote": null,
        "tissSadtLote": null,
        "tissHonorarioLote": null,
        "observacao": "ttt",
        "pagadorTipo": 0,
        "pagadorDescricao": null,
        "pagadorDocumento": null
    },
    "error": []
}
 
SALVAR OBJETOS EM PILHA
post
fluxo_receita/bulk
put
fluxo_receita/bulk

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
referencia integer
paciente integer
conta integer A propriedade "conta" é obrigatória.
pago boolean A propriedade "pago" é obrigatória.
recibo integer A propriedade "recibo" é obrigatória.
categoria integer A propriedade "categoria" é obrigatória.
categoriaSub integer
tipoPagto integer A propriedade "tipoPagto" é obrigatória.
dataVencto date A propriedade "dataVencto" é obrigatória.
dataEmissao date A propriedade "dataEmissao" é obrigatória.
dataPagamento date
dataRecibo date
valor decimal A propriedade "valor" é obrigatória.
valorTotal decimal A propriedade "valorTotal" é obrigatória.
valorJuros decimal
valorMulta decimal
valorOutros decimal
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
agendamento integer
agendamentoProfissional integer
agendamentoServicoAdicional integer
tissConsultaLote integer
tissSadtLote integer
tissHonorarioLote integer
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "500".
pagadorTipo boolean
pagadorDescricao alphaNumeric A propriedade "pagadorDescricao" deve possuir tamanho mínimo de "3" e máximo de "120".
pagadorDocumento document A propriedade "pagadorDocumento" deve possuir tamanho mínimo de "3" e máximo de "14".
https://api.ninsaude.com/v1/fluxo_receita/bulk

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": [
        3602,
        2256
    ],
    "error": []
}
 

RECEITAS RECORRENTES fluxo_receitarecorrente

 
LISTAR TÍTULOS RECORRENTES
get
fluxo_receitarecorrente/listar
get
fluxo_receitarecorrente/listar/repetir/dataInicial/inicial/{repetirDataInicialInicial}/final/{repetirDataInicialFinal}

Nome Tipo Descrição
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).
conta mixed Índice das contas bancárias (optional).
tipoPagamento mixed Índice dos tipos de pagamento (optional).
paciente mixed Índice dos pacientes (optional).
repetirDataInicialInicial string Repetir data inicial inicial (optional).
repetirDataInicialFinal string Repetir data inicial final (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
fluxo_receitarecorrente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_receitarecorrente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "paciente": null,
        "conta": 5,
        "recibo": 0,
        "reciboProfissional": null,
        "categoria": 19,
        "categoriaSub": null,
        "tipoPagamento": 27,
        "valor": 6.77,
        "valorTotal": 6.77,
        "pagadorTipo": 0,
        "pagadorDescricao": null,
        "pagadorDocumento": null,
        "documento": null,
        "observacao": null,
        "repetirDataInicial": "2017-10-27",
        "repetirDataFinal": null,
        "repetirIntervaloDia": null,
        "repetirAno": null,
        "repetirMes": null,
        "repetirDia": 27,
        "repetirSemanaAno": null,
        "repetirSemanaMes": null,
        "repetirSemanaDia": null,
        "repetirNumeroOcorrencia": 5
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_receitarecorrente/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_receitarecorrente/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_receitarecorrente
put
fluxo_receitarecorrente/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
paciente integer
conta integer A propriedade "conta" é obrigatória.
recibo integer A propriedade "recibo" é obrigatória.
reciboProfissional integer
categoria integer A propriedade "categoria" é obrigatória.
categoriaSub integer
tipoPagamento integer A propriedade "tipoPagamento" é obrigatória.
valor decimal A propriedade "valor" é obrigatória.
valorTotal decimal A propriedade "valorTotal" é obrigatória.
pagadorTipo boolean
pagadorDescricao alphaNumeric A propriedade "pagadorDescricao" deve possuir tamanho mínimo de "3" e máximo de "120".
pagadorDocumento document
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "500".
repetirDataInicial date A propriedade "repetirDataInicial" é obrigatória.
repetirDataFinal date
repetirIntervaloDia integer A propriedade "repetirIntervaloDia" deve possuir valor compatível com a expressão "repetirIntervaloDia > 0".
repetirAno integer A propriedade "repetirAno" deve possuir valor mínimo de "1980" e máximo de "2100".
repetirMes integer A propriedade "repetirMes" deve possuir valor mínimo de "1" e máximo de "12".
repetirDia integer A propriedade "repetirDia" deve possuir valor mínimo de "1" e máximo de "31".
repetirSemanaAno integer A propriedade "repetirSemanaAno" deve possuir valor mínimo de "1" e máximo de "52".
repetirSemanaMes integer A propriedade "repetirSemanaMes" deve possuir valor mínimo de "1" e máximo de "5".
repetirSemanaDia integer A propriedade "repetirSemanaDia" deve possuir valor mínimo de "1" e máximo de "7".
repetirNumeroOcorrencia integer A propriedade "repetirNumeroOcorrencia" deve possuir valor compatível com a expressão "repetirNumeroOcorrencia > 0".
https://api.ninsaude.com/v1/fluxo_receitarecorrente

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 7326,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_receitarecorrente/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_receitarecorrente/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

OCORRÊNCIAS DAS RECEITAS RECORRENTES fluxo_receitarecorrenteocorrencia

 
LISTAR OCORRÊNCIAS
get
fluxo_receitarecorrenteocorrencia/listar/receitaRecorrente/{receitaRecorrente:^[0-9]++$}
get
fluxo_receitarecorrenteocorrencia/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
receitaRecorrente mixed Índice das receitas recorrentes (optional).
status mixed Status das ocorrências (optional).
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
BUSCAR RECEITA DA OCORRÊNCIA
get
fluxo_receitarecorrenteocorrencia/buscar/receita/receitaRecorrente/{receitaRecorrente:^[0-9]++$}/data/{data}

Nome Tipo Descrição
receitaRecorrente integer Índice da receita recorrente.
data string Data da ocorrência.

 
ADICIONAR OCORRÊNCIA DO TIPO TÍTULO
post
fluxo_receitarecorrenteocorrencia/adicionar/titulo/receitaRecorrente/{receitaRecorrente}

Nome Tipo Descrição
id integer
receitaRecorrente integer A propriedade "receitaRecorrente" é obrigatória.
status integer A propriedade "status" é obrigatória.
data date A propriedade "data" é obrigatória.
receita integer

Notice: Undefined index: {receitaRecorrente} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/fluxo_receitarecorrenteocorrencia/adicionar/titulo/receitaRecorrente/ Content-type: application/json Authorization: bearer <<access_token>> { "result": 5451, "error": [] }
 
ABRIR OBJETO
get
fluxo_receitarecorrenteocorrencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_receitarecorrenteocorrencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "receitaRecorrente": 10,
        "status": 0,
        "data": "2017-10-01",
        "receita": 553
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_receitarecorrenteocorrencia/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_receitarecorrenteocorrencia/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_receitarecorrenteocorrencia
put
fluxo_receitarecorrenteocorrencia/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
receitaRecorrente integer A propriedade "receitaRecorrente" é obrigatória.
status integer A propriedade "status" é obrigatória.
data date A propriedade "data" é obrigatória.
receita integer
https://api.ninsaude.com/v1/fluxo_receitarecorrenteocorrencia

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2237,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_receitarecorrenteocorrencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_receitarecorrenteocorrencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

TRANSFERÊNCIAS BANCÁRIAS fluxo_transferencia

 
LISTAR
get
fluxo_transferencia/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade mixed Índice das unidades de atendimento (optional).
categoria mixed Índice das categorias (optional).
categoriaSub mixed Índice das subcategorias (optional).
conta mixed Índice das contas bancárias (optional).
tipoPagamento mixed Índice dos tipos de pagamento (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
fluxo_transferencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_transferencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "accountUnidade": 1,
        "origemDespesa": 679,
        "origemCategoria": 22,
        "origemCategoriaSub": null,
        "origemConta": 2,
        "destinoReceita": 546,
        "destinoCategoria": 9,
        "destinoCategoriaSub": null,
        "destinoConta": 11,
        "tipoPagamento": 27,
        "data": "2017-11-03",
        "valor": 500,
        "documento": null,
        "observacao": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
fluxo_transferencia/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
fluxo_transferencia/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
fluxo_transferencia
put
fluxo_transferencia/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
accountUnidade integer A propriedade "accountUnidade" é obrigatória.
origemDespesa integer
origemCategoria integer A propriedade "origemCategoria" é obrigatória.
origemCategoriaSub integer
origemConta integer A propriedade "origemConta" é obrigatória.
destinoReceita integer
destinoCategoria integer A propriedade "destinoCategoria" é obrigatória.
destinoCategoriaSub integer
destinoConta integer A propriedade "destinoConta" é obrigatória.
tipoPagamento integer A propriedade "tipoPagamento" é obrigatória.
data date A propriedade "data" é obrigatória.
valor decimal A propriedade "valor" é obrigatória.
documento alphaNumeric A propriedade "documento" deve possuir tamanho mínimo de "3" e máximo de "500".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "500".
https://api.ninsaude.com/v1/fluxo_transferencia

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3085,
    "error": []
}
 
EXCLUIR OBJETO
delete
fluxo_transferencia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/fluxo_transferencia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

ARQUIVOS geral_arquivo

 
LISTAR
get
geral_arquivo/listar

Nome Tipo Descrição
id string Pasta e nome do arquivo (optional).
tipo string Tipo (optional).
extensao string Extensão (optional).
tamanho integer Tamanho (optional).
imagemLargura integer Largura da imagem (optional).
imagemAltura integer Altura da imagem (optional).
dataHoraInicial string Data e hora inicial (optional).
dataHoraFinal string Data e hora final (optional).

 
EXCLUIR ARQUIVOS
delete
geral_arquivo/{diretorio}/{arquivo}

Nome Tipo Descrição
diretorio string Diretório.
arquivo string Arquivo.

Notice: Undefined index: {diretorio} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347

Notice: Undefined index: {arquivo} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/geral_arquivo// Content-type: application/json Authorization: bearer <<access_token>> { "result": true, "error": [] }
 
ABRIR OBJETO
get
geral_arquivo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/geral_arquivo/1

Content-type: application/json
Authorization: bearer <<access_token>>


 
BUSCAR OBJETOS
get
geral_arquivo/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
geral_arquivo/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
geral_arquivo
put
geral_arquivo/{id:^[0-9]++$}

Nome Tipo Descrição
id alphaNumeric A propriedade "id" deve possuir tamanho mínimo de "3" e máximo de "100".
tipo alphaNumeric A propriedade "tipo" deve possuir tamanho mínimo de "3" e máximo de "45".
extensao alphaNumeric A propriedade "extensao" deve possuir tamanho mínimo de "3" e máximo de "10".
tamanho integer A propriedade "tamanho" é obrigatória.
imagemLargura integer
imagemAltura integer
dataHora dateTime A propriedade "dataHora" é obrigatória.
binario alphaNumeric A propriedade "binario" é obrigatória.
https://api.ninsaude.com/v1/geral_arquivo

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9743,
    "error": []
}
 
EXCLUIR OBJETO
delete
geral_arquivo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/geral_arquivo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

BATE PAPO geral_batepapo

 
LISTAR BATE PAPO
get
geral_batepapo/listar/usuarioOrigem/{usuarioOrigem}/usuarioDestino/{usuarioDestino}

Nome Tipo Descrição
usuarioOrigem integer Índice do usuário de origem.
usuarioDestino integer Índice do usuário de destino.
status integer Status (optional).
dataHoraInicial string Data e hora inicial (optional).
dataHoraFinal string Data e hora final (optional).
tipo integer Tipo de mensagem (optional)
limite integer Quantidade máxima de registros (optional).
offset integer Faixa de registros (optional).

 
MARCAR MENSAGENS COMO LIDO/NÃO LIDO
put
geral_batepapo/alterar/status/usuarioOrigem/{usuarioOrigem}

Nome Tipo Descrição
usuarioOrigem integer Índice do usuário de origem.
status integer Status.
id mixed Índice das mensagens (optional).
https://api.ninsaude.com/v1/geral_batepapo/alterar/status/usuarioOrigem/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8407,
    "error": []
}
 
ABRIR OBJETO
get
geral_batepapo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/geral_batepapo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "usuarioOrigem": 2,
        "usuarioDestino": 26,
        "dataHora": "2017-10-05 17:42:08",
        "status": 0,
        "mensagem": "we"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
geral_batepapo/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
geral_batepapo/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
geral_batepapo
put
geral_batepapo/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
usuarioOrigem integer
usuarioDestino integer A propriedade "usuarioDestino" é obrigatória.
dataHora dateTime
status required
mensagem alphaNumeric A propriedade "mensagem" é obrigatória. A propriedade "mensagem" deve possuir tamanho mínimo de "2" e máximo de "1000".
https://api.ninsaude.com/v1/geral_batepapo

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 1525,
    "error": []
}
 
EXCLUIR OBJETO
delete
geral_batepapo/{id:^[0-9]++$}

https://api.ninsaude.com/v1/geral_batepapo/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

CONTATOS DO BATE PAPO geral_batepapocontato

 
ADICIONAR USUÁRIO AOS FAVORITOS
put
geral_batepapocontato/adicionarFavorito/{usuarioDestino:[0-9]++}

Nome Tipo Descrição
usuarioDestino integer Índice do usuário de destino.

Notice: Undefined index: {usuarioDestino:[0-9]++} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/geral_batepapocontato/adicionarFavorito/ Content-type: application/json Authorization: bearer <<access_token>> { "result": 9777, "error": [] }
 
REMOVER USUÁRIO DOS FAVORITOS
put
geral_batepapocontato/removerFavorito/{usuarioDestino:[0-9]++}

Nome Tipo Descrição
usuarioDestino integer Índice do usuário de destino.

Notice: Undefined index: {usuarioDestino:[0-9]++} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/geral_batepapocontato/removerFavorito/ Content-type: application/json Authorization: bearer <<access_token>> { "result": 6178, "error": [] }
 

PING DO BATE PAPO geral_batepapoping

 
PING
get
geral_batepapoping/ping


 
LISTAR USUÁRIOS
get
geral_batepapoping/listar/usuario


 
ALTERAR STATUS
put
geral_batepapoping/alterar/status

Nome Tipo Descrição
status integer Status (optional).
https://api.ninsaude.com/v1/geral_batepapoping/alterar/status

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3434,
    "error": []
}
 

GEOLOCALIZAÇÃO DE ENDEREÇOS geral_enderecogeolocalizacao

 
CRIAR GEOLOCALIZAÇÃO EM LOTE
post
geral_enderecogeolocalizacao/criar/lote

Nome Tipo Descrição
id integer
cidade integer A propriedade "cidade" é obrigatória.
estado alphaNumeric A propriedade "estado" é obrigatória. A propriedade "estado" deve possuir tamanho mínimo de "3" e máximo de "37".
logradouro alphaNumeric A propriedade "logradouro" é obrigatória. A propriedade "logradouro" deve possuir tamanho mínimo de "3" e máximo de "100".
latitude
Notice: Array to string conversion in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 170
Array
A propriedade "latitude" é obrigatória.
longitude
Notice: Array to string conversion in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 170
Array
A propriedade "longitude" é obrigatória.
https://api.ninsaude.com/v1/geral_enderecogeolocalizacao/criar/lote

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9307,
    "error": []
}
 
ABRIR OBJETOS EM PILHA
get
geral_enderecogeolocalizacao/bulk/id/{id}

https://api.ninsaude.com/v1/geral_enderecogeolocalizacao/bulk/id/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "cidade": 140285,
        "estado": "Rio Grande do Sul",
        "logradouro": "Bernardo Gressler 34",
        "latitude": -28.384586,
        "longitude": -53.928162
    },
    "error": []
}
 
SALVAR OBJETOS EM PILHA
post
geral_enderecogeolocalizacao/bulk
put
geral_enderecogeolocalizacao/bulk

Nome Tipo Descrição
id integer
cidade integer A propriedade "cidade" é obrigatória.
estado alphaNumeric A propriedade "estado" é obrigatória. A propriedade "estado" deve possuir tamanho mínimo de "3" e máximo de "37".
logradouro alphaNumeric A propriedade "logradouro" é obrigatória. A propriedade "logradouro" deve possuir tamanho mínimo de "3" e máximo de "100".
latitude
Notice: Array to string conversion in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 170
Array
A propriedade "latitude" é obrigatória.
longitude
Notice: Array to string conversion in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 170
Array
A propriedade "longitude" é obrigatória.
https://api.ninsaude.com/v1/geral_enderecogeolocalizacao/bulk

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": [
        7916,
        9499
    ],
    "error": []
}
 

LOG DE OPERAÇÕES log_operacao

 
LISTAR RESUMO
get
log_operacao/listar/resumo/controller/{controller}/indice/{indice}
get
log_operacao/listar/resumo/controller/{controller}/indice/{indice}/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
controller string Nome do controller.
indice mixed Índices dos registros.
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
DESFAZER OPERAÇÃO
put
log_operacao/desfazer/operacao/{operacao}/controller/{controller}/indice/{indice}

Nome Tipo Descrição
operacao integer Índice da operação.
controller string Nome do controller.
indice mixed Índice do registro.
https://api.ninsaude.com/v1/log_operacao/desfazer/operacao/1/controller/atendimento_agenda/indice/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9333,
    "error": []
}
 

ALERGIAS prontuario_alergia

 
LISTAR ALERGIAS
get
prontuario_alergia/listar
get
prontuario_alergia/listar/paciente/{paciente}
get
prontuario_alergia/listar/paciente/{paciente}/medicamento/{medicamento}
get
prontuario_alergia/listar/prontuario/{prontuario}

Nome Tipo Descrição
paciente integer Índice do paciente (optional).
prontuario mixed Índice dos prontuários (optional).
medicamento mixed Índice dos medicamentos (optional).

 
ABRIR OBJETO
get
prontuario_alergia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_alergia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "prontuario": 127815,
        "tipo": 1,
        "agente": "ABATACEPTE",
        "reacao": null,
        "observacao": "obs..."
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_alergia/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_alergia/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_alergia
put
prontuario_alergia/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
prontuario integer A propriedade "prontuario" é obrigatória.
tipo integer A propriedade "tipo" é obrigatória. A propriedade "tipo" deve possuir um dos valores da lista "1, 2, 3".
agente alphaNumeric A propriedade "agente" é obrigatória. A propriedade "agente" deve possuir tamanho mínimo de "1" e máximo de "250".
reacao alphaNumeric A propriedade "reacao" deve possuir tamanho mínimo de "1" e máximo de "250".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "1" e máximo de "250".
https://api.ninsaude.com/v1/prontuario_alergia

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9945,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_alergia/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_alergia/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

DOCUMENTOS prontuario_documento

 
LISTAR DOCUMENTOS
get
prontuario_documento/listar
get
prontuario_documento/listar/paciente/{paciente}
get
prontuario_documento/listar/prontuario/{prontuario}
get
prontuario_documento/listar/preAgenda/{preAgenda}

Nome Tipo Descrição
paciente mixed Índice dos pacientes (optional).
prontuario mixed Índice dos prontuários (optional).
preAgenda mixed Índice dos pré-agendamentos do checkup (optional).

 
ABRIR DOCUMENTO TRADUZIDO POR PRONTUÁRIO
get
prontuario_documento/abrir/traduzido/documento/{documento}/prontuario/{prontuario}

Nome Tipo Descrição
documento integer Índice do documento.
prontuario integer Índice do prontuário.

 
ABRIR DOCUMENTO TRADUZIDO POR PRÉ-AGENDAMENTO
get
prontuario_documento/abrir/traduzido/documento/{documento}/preAgenda/{preAgenda}

Nome Tipo Descrição
documento integer Índice do documento.
preAgenda integer Índice do pré-agendamento.

 
ABRIR COMPLEMENTO TRADUZIDO
get
prontuario_documento/abrir/traduzido/complemento/{complemento}/prontuario/{prontuario}

Nome Tipo Descrição
complemento integer Índice do complemento.
prontuario integer Índice do prontuário.

 
ABRIR OBJETO
get
prontuario_documento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_documento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "paciente": 11558,
        "profissional": 1,
        "prontuario": 127875,
        "descricao": "Simples",
        "note": "<p>qewqewe<\/p><p>wqeweewewe<\/p><p><img src=\"data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAR0AAABICAIAAABEPLbcAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAABY7SURBVHhe7Z33d1XFFsff\/+EP\/vKWz+dblgeCdAIYumBoAkoTUESKAiIiIEJAOpjwaGJAmgFp0nvvPbQk9EgnhV6U9j7crYdhTrkn4eaY3Dt3nXXXzc2cfWb27O\/sPbvM\/cdj8zIcMByINAf+EWmChp7hgOHAY4MrIwSGA5HngMFV5HlqKBoO6Lh69Pjxw0dBX494qnkZDkQRB3RczUzLrpZyNGFWZmBX9anpk3ZfjiKWmqEYDtj2V0nbL74wdO+ryWmBXS8O35e44ZyZCsOBaOKArq\/G7bz0z1H7S40\/FNj18pgDQzedjyaemrEYDhhcGRkwHIg8BwyuIs9TQ9FwwODKyIDhQOQ5YHAVeZ4aioYDBldGBgwHIs8Bg6vI89RQNBwwuDIyYDgQeQ4YXEWep4ai4YDBlZEBw4HIc8DgKn88ffTo0fHjx3fv3n3s2LGHDx\/m7+bYaH3t2rVt27Zt3cqb12vLlq2w8fbt2xHkyo0bN\/bt27d3717e5bVnz57Dhw8zaxF8ih9SBld+uPRnmzNnzvTv\/23duu+ULv1W7dp1+vfvn5WVlY\/7Y6MpYl2uXPkyZcry7nG9+Wapd96pd+LEiQhyZefOnRUqVHzrrTLWc0uUKNmwYaMHDx5E8Cl+SBVjXF2\/fq1Pn74tW7Zs1679X1e7Vq1aT536k5+RS5vc3Nxevb5q2bKVRaRt6HX+vJ6yePPmrU6dOjFPlSvHVav2Nu9IRqdOnfPy8vw\/LhZa7t+\/v2rVanFxVXj3uABAo0aNT506FUGeoJ3efjueqbGeW758hebN3ze4ygeTc3NzmjZtjqCriyKaBJ6ybvkkdOnSJdazkiXftIiw0HKdPHlSo7Bq1SomrHLlKoBKripVqiIcCxcu9PmsGGkGroQ5FqMcP1SsWKlx4yYRx1V8fHUgbT2RCXr\/\/Q8MrvIhe3l5ua1bt2FB0qYNVHTu3PXmzZt+aF2+fBm+w30VLcjE6dOntdvHjBmDglKfBYC5MSkp2c+DYqdNvuzAkycjaQeirwyu\/ixFKXCdiBuuEPeyZctNmTLVjyj7x9WECRNEGVrQ4jOonjhxkp8HxU6bjIyMjz76GLuad4+rTZsPv\/ii57lzkSy9M7h6Wt8VcVwh95UqVWZPfPRoelhp9o8r3Eq1atXGXFRtjOrVa6SlpYV9Skw1+OOPP3Jz89i4ht49rtyrV69G1kIzuCpcXCH6qKxevXrdv3\/fW6b94wo6eESw3UuVKg260F2gNyUlJXgfbkyhNF+DNbgqdFyxR2JnPHv2nAjiClIbN24cNGhw9+49eN+8ebMBVb7kvrAbG1wVOq5QWeAqISHh7NmzHtOZL31l0blz505hi4ihXwAOGFwFgSuxBgcMGOBhDRYMVwWYcvUWoslkIixc+CuvLVu2sNEvwDaDnh88eBD9uWDBgqVLl27fvp3YQH7pXL2ad+TIERTvokWL5odeq1at3rNnb9GMd+OkhW90dd68+QsWLNy0aVNm5jHVZHhOXN26devQoUPr1q2DpfPmzVu2bPmOHTtOndI9w35mvxjHhd38gaornO0QWmvlypVuvPCPK+Zv+PAR3bt3J44sV8+ePfv27Xv9+nWVOF7mLl26Wm340KVLF\/BDG5JpduzYyS3vvdcUdzD7NC7imAkJDT\/77PNFixb7QQXdIEXo228HtGjRsl69+pi7eP8JLeBBadLkPeLUM2fOvHLlivfc5+TkLF++HCIfftg2IaEBHGO7SBCPC3aRStKsWfMePXrMnTtPG51KFikcPXq0yhA2tD16fJGV9Zvb03\/4YTIjVZjTC4t6165d3r2lD6AIyvCtevXq0lVGjT+2QYOGUAADElaB+QXzs2dmZowbN\/7jjzvUr\/+uRPyJi7Io16hRE65269YtNTUVP4wfREmbKMSVFpHEx4BLNzs725Ep\/nFFNiCz+Nprr5MmI1eJEk+kUBPiJUuWvPzyv602fHjppX8lJSXdu3cPWDLrYIColxW7FOTzJV4QBB2J95g8RsG+Tojg4ucWGazkNwgdiAO5DRs2ONJh9Z0wYWLTpk1pj9zAHIiogVQIIlgQEVJt27ZjzXYkRaJJ06bNVIYg8W+88d+DBw+5DeHTTzu98sp\/LObQ\/vXX3\/AOrK9fv75NmzZ0kt6qfGPUMmS+550FBYctChwk5CsujE9y7Nj\/4emFn8INS36EqxYriHMuW7bMZ1JoFOKqTp26GrQQkZEjRz4\/rpBXNQyN\/DEfGmLRjWghVWfydMDA0o48SQ6U48UUImes5egBx65evHixc+fOpUt7ERGMIR9wYO7cuRodzBu0U5ky5VTp8ciKgAhSW7t27Y0bN9m7hESi7lSG8GhE\/MiRo264QufABDUAiNRixDq2v3\/\/wcSJE+Pi4niEd\/YG\/2XIDRo0GD16DMpWbeydb5GefrRDh09kUVMjk3aeQJNu8GIe\/eyuowpXsIa1fMqUKe++m6BKMJ8xk3bt2m2fv3zpq4Lhil4BdT+pPSIf06fPsPeTZRJtBmK16VcT8FRpQFC4MJDU7cePP6ZooW3vVCP5L\/LkGAwsVFxhM48fP6Fs2ScS76eTErTkHbtabe+Bq\/T09GbNmtkZ4sZS0ZCsC8OGDQ+rtaIKV8hlKAXpDMkWrMqqCLImEfunjkAT2QBwJYiSzoj3H0nlXTVX1Fgzexv7BomNGfdqt0CEC3niHQFSRTD0r4rkiKi4ys7Oad26taVh6BK3cKN6OWpUuNe3bz9NmAoVV8uXrwhlYzqo95Bt9oSHIQVSUW1jV2tuuGKzhImrKk9R9cJJYax81njOn+XKVfjlF90W0OQq2nCFoJw+nYUpxZ5KzY0Q6whV9rfgylr4mXiSuNF77IYlDUpbjAV48+cv0Po5duxYGqsrRcWKlXGQkA3Muotn7Pvvk9hzIwe0AQa4NNi3\/P777zZTcD50ZHMliohtA1t\/6l+++aY\/S0\/NmrW0B9FDZBf7igVLpVZ4uDp79hwuCkfmMLT4+Hj+Cw+5WIPYUDEWN0PRDVejRo2GlD0rjdkZOnTYkiVLsednzJiBVwYLiBlR1aBk4v\/2m6t7Jtr8FjAXXGVmZjIwHNBIj7rYSHITJrUqHMHoK7GmqGFZvHgxFSgs\/GgkJq9du3Z26cEyQco15YBLSm3JWFq0aHH58jN+v8OHj1Dhgq+sY8eOBw4ccNy0UEfYoUMH1ulPPuk4bdq0Q4cOq7sFlBteis6du6iJyKJm4eSvvy4KAFf0Adec3TwD2\/Thq696r169Gm0Df3hhgGzatLlfv28QfUfl5oirffv2g0ZVvUtOae\/evc+ceaag7uHDR2vXrq1Xr57KEBrDwEmTfvDICohCfSW4YsyDB3\/HmqQqBHiHn1dNdQ8GV0ACCNlrui5cOI+K0KDFn2ym0QaqELdq1UZVv3xGmOzIoUwwJWWKd0kYyFm6dNm1a8+EB1RS+CQxF9GHGutGjBgRAK6YEdyMdmADA0TZMRRJfGLOnDmoFPtmzI4r0IgbCdyqo4PneBTdggrr1q0HhypugTGd9HDeRi2ukADkuHnz5nZrULWyAsCVbK62bt3iqEDwI7MMq2YMwtG4cWOtUIWSSnUgzDFW386dYSI\/bn65sN\/PmfNL2bJPM4wlwNW799fqCl1IduCaNWvEmlXdhsg9sQrvbpOribhrfh07rgiv4RRVEQgzsX6JKXvQHzgwUSsmggKq0u2WaMYVY165cpVmDcJ6ChmtIHoAuEImMLrsLhOZEtz0WhWZYIbzM9Q5S05O1qSNeWUTNX36dO+QV1gI0UBsKrUlQoZuV2WUP1nR7969azUrJFyBH7sCx4Tm2AzvsWDiUpyirj4g044rzEj70NipehMnLYZ5UUNbCBJhgBjFFcMePHgwfFSVPsYxRpQsvQHgCluUld4tl+Lu3TvsZ9Qeij+DM1XUOcMzYY+xhBxWldjEDxw4kP2k\/4QASjmIMpGUjKnctetnuC7wAfAB5we7Pmqo9+zZjYBquCKqe\/v209haYeAKeCPi2maGMRLL9rNAzJgxUwvN2XGFj1RdoaQ4tU+fPixkJJS5vUhu0iIlzBHHQMQurkTvq1MlRy9gb8AU\/Ac+64WZ8oLFr7xxdefObfSAhiuQv337M1kOeBc+\/7ybFnFWHffIE1FadvwnTugnCGhzD2LZoBPQAzniYbd81nzmSxhCEpPmYaOHIVw9PT6pMHCFPmSZ0CaLjdPmzc5WtDY0Uj0Yl3e+BUuqtnkTD7tE\/Nwue1AEO7l9+4\/cDnqKcjtQ+E6aJlEeS1CYJ0IQHCfCAo91UQRxBRQJWGlCgz8GmXML7IqWA5AkW+GUd3NdEHTGcQwRWVw0L7+ERCXCpv0rGFyR70tMX9v8EFXHrPCjr7KzrxAPUB0Mmr7CasDqdsSVGg52\/KwxBCIffNAiJ8c5aTAmcIXZQ0qophNYmInoU9CKFtK2pI7nWwSprxxxhWCRe45S8s67YSw0IOhpT8TGsS5BT1VEkCEwJkFYdQvxt+CKsxnZNGq44mA5j\/RfFW8slN64wp2o6UMZJkyQpAL\/F\/IDKZLLHAEfE7hi5MeOHWchV0VKvEAET9nsFhdcieHKZoNFXfJEHeOhEmBhr3\/hwtNZ57BKksE1UIEo6GA7EdnjQijlG3vqUDD6iuOZ8NnYceVz6+gHVygZu77ymSqlZUhh8rAXjWlcMXh8xzBU82iT2c1Eql\/+lQx1WuNXUdBXVpeyss5wXg05JZKx5pgSxfckicotrNNff91HS9vhLtLpEhMTqd0SkxgV9\/PPqahEu+QFgytCixx+poKfTgJ7zk7zYweSehI2n53DajS\/CMsQKX\/4CVesWOn\/Iga4YcNGt\/N6Y0VfMSu3bt1m669Fiu3bjGKBKxEyNlGEv8jck+QjTXchnaTbyM6EkkfUkaoHaIzGJlXHLq+4\/gmXadDyj6v09Aw3DCDT3vnsLF4EyjW5Z45IIPaDK+oytWCg3R84YsRI1R8oiWM\/\/ZSPs1z99CSGcAU7qM+pWbO2d4p0McKVpYsQZVKf5JxXy1ZBwuLjaxB4oRkVwVo6HDYkZXxuNSn437QYqx1X+ACIEKjrlPg8KDd2lLxQe93ziYhrdSJDhw7VIE1XiQGELfpEJ9MsbPyKrAB7\/IqBPHgQ5oghP3Cy2sQWrhj2tGnTtciMPfO1yPotPKYW38yQIUPVrVFII7HSz+cuyl01gcNlP2jQIDeCJJUSnFAda3ZccW\/Pnl9quAISbrEmStzr1q2rZeXZcUVhqCb3YlOEPVc4pKz0lH+7viJCVbPmM7WPYkWvXbsuLHJgI0tz2GY0iDlcYRB37PipZg2q0CrK+orsdfSSW4IFp2erVpZkIaem\/sw0U+OoBcfhAMnabiJC2i6KTzUsHXFFHaFqU0nmO4A8elQvbaRcGntV64PEZDV95ZgfiBok+ZV9oFuHqY\/Gbah5ZRzzLQiREZ1TBYBNJutRo0ZNKON3o8+yRZ4UzRo2bEgmblhoxRyuQtbgIUIibtZgkcUVx5jUqlWHcxfYJbLo2qeWtBpVcENuiXgJf5OXhMxVYV3+q1qZ\/7LFh6adDpJHJoHmFXTEFUe4aPuZqlWfHINF2i4JInfv3oM4WyYib4mJg+zJe4644pakpLGai4VuczuzhnDji1fTFMmTmDz5RzyZdlA54gr61IDQWHP2gHA8WOSFaa5zEMXv\/bAo0ICMet4pVJk0aZL3QeWxiCs4O378eDeVVQRxxc4BIweQEHuSkhMkABcWizSaATnDOCHTgoDvs97OOHwVkr974cIFSpW0fQsrC5KKUFJYhfQAALQKiw6g0rZqPNQRVzxay28Q3IaErzq7HdJV8VWwxpcv7xAScMMVxRoERezufnpFBTFJydifUObi2AJ8M0yl+nsUmjfc\/rsHLBxfftnLLgAwBGuZH5f57rshlAXMmjULhUwBBG4htcSrUqU4mvFot6BwLNqBsjzjVm7fvr2Wsi3zUQRxhe9bjjSxJIbllm+QaYwfwCPqV1uAQ2mQ\/WRp533UqFGORU1kokCBlBwEhRA5J3Zo0Qh5qCOuALxssbTqd9pL6SS7OIliW+FXLSRttwNlgthlSbTaHlli7NCU06wYo1bPYs+KcPw9EVYEHPqaXSoBYklb4Sk8napznmUPY\/BoTuNy8\/rELq4YOUn+WEX2mSuCuCJXEDtHczxYeRIsn3b1QuP69euTn2GZeeRJkh\/gKEnIfSiF90kqhkVKy3JyxFWIjZskuS5saJU2KDEVgW76ShaC5OSx+TrfQryRWrDB7rewGLJ161YWJs1HYo1CMjDsqV58CdJwpVLU7LHLilE7UDhC8YWdrUUQV3QVdzkJPsyoY4KFJtOACg\/7ihUrtInnWCXUkR1a2u2yZmuLtBuuAAD1jqzf+OLcoAVBek6iOrFpSb2z1JebvqLnHCKAcct4w3ZYrAxASOwL49MjP1BjCCnIpF+gxj3OyVIHJaqSgXiDqnjrK35XDhXPjDJauZAGhu24p3dcWqQwVqUgRLjsv3fG9oMSUbWxzLd2xgvnXXImntUlPuBpwFhyC7+Qz87iJwdiyoWoccu2bbrv68CBtG7duvNfuieJfKqASpyX27FhYAuLseOQKYUkSwMuiWpSifAZLAl9CltI70LgrF7RQ6TWMb2A5L0BAwZyY2hn\/7RGUzSqdImcfcpMyRGBpihGGSl\/cjaBx8K\/evUaRB9W09ht1KwjUBsyZMilS5fZdpYsWcrqNvQ5SsQj9nXu3HmKZZjHEJHK7oytDNOwtykzcSulU0dRjPXVtWtXWZxYxTGU5aJgkcQ5+08tekwbqSjcyC5ZJQId+6kg4ArhUB+HQ1mS4lX6+BLY5lrU+MBksA\/2qL9CiNkmWbewEecW0vns3UasqdRk1KEzEp+chCPbDLYBku8DoihWv3TJORlUCHIqE1ntCKu4HLgXCvLzKIgX7g2qmChLSU2dzVPojHSMHnK2hNvReXgCOP2C7RmWHnQAEjTFBQ8zUTtyrADOAKxTiyYfcMCIx9LjxTEeM2fOYjmoUaOWqC8ZtfgS6CQMWbNmrewk+Zk\/tosWM6FPeUvYmDL+UmDZpEkTqbdXH8Gfcuot1o3\/JbsY4wo+4r9iRrVX2LPdtCl0JCKTVICWTOGdO3qX7OciqZT5b75GwSNII+bc6XHjxqEoOFcQtxUHPFBa4mcplUffuHFz9+49lDZyLxSQKsBGVlRe3hMA8IKNWq+8R8EtuJ7Rk8By+PDhlFpOnjyZgJta4oHX0T7SsEIv\/QHSaWkHCXODHIgzcH5BkzPuMzIyVQr2RzC\/3ri1\/ssSiT5nQYHygNCLD\/zJlz4Tfy1SxRhXPpllmhkOBM8Bg6vgeW6eGP0cMLiK\/jk2IwyeAwZXwfPcPDH6OWBwFf1zbEYYPAcMroLnuXli9HPA4Cr659iMMHgOGFwFz3PzxOjngMFV9M+xGWHwHNBxlbT94gvD9r6anBbY9eKIfYkbvFKDg2eKeaLhwHNyQMfV7IM5daZlNJt9PLCr\/ozMlL1hfr\/9OQdpbjccCJgDOq7IiiMzLugr4EGbxxkOFDIHdFwV8uMMecOBmOCAwVVMTLMZZMAcMLgKmOHmcTHBAYOrmJhmM8iAOfB\/4yyTuVl2o5cAAAAASUVORK5CYII=\" data-filename=\"logo-novo.png\" style=\"width: 285px;\"><\/p>",
        "data": "2017-10-27",
        "hora": "13:22:22"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_documento/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_documento/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_documento
put
prontuario_documento/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
paciente integer A propriedade "paciente" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
prontuario integer A propriedade "prontuario" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "120".
note alphaNumeric
data date A propriedade "data" é obrigatória.
hora time A propriedade "hora" é obrigatória.
https://api.ninsaude.com/v1/prontuario_documento

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 613,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_documento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_documento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

TAGS prontuario_expressao

 
LISTAR EXPRESSÕES
get
prontuario_expressao/listar/prontuario/{prontuario}
get
prontuario_expressao/listar/documento/{documento}
get
prontuario_expressao/listar/paciente/{paciente}

Nome Tipo Descrição
prontuario integer Índice do prontuário (optional).
documento integer Índice do documento (optional).
paciente integer Índice do paciente (optional).
expressao string Filtro por expressão (optional).
filter string Filtro padrão do framework (optional).

 
LISTAR EXPRESSÕES AGRUPADAS
get
prontuario_expressao/listar/agrupada
get
prontuario_expressao/listar/agrupada/paciente/{paciente}

Nome Tipo Descrição
prontuario integer Índice do prontuário (optional).
documento integer Índice do documento (optional).
paciente integer Índice do paciente (optional).
expressao string Filtro por expressão (optional).
filter string Filtro padrão do framework (optional).

 
CRIAR LOTE DE EXPRESSÕES
post
prontuario_expressao/criar/lote/prontuario/{prontuario}
post
prontuario_expressao/criar/lote/documento/{documento}

Nome Tipo Descrição
id integer
paciente integer A propriedade "paciente" é obrigatória.
prontuario integer A propriedade "prontuario" é obrigatória.
documento integer
expressao alphaNumeric A propriedade "expressao" é obrigatória. A propriedade "expressao" deve possuir tamanho mínimo de "3" e máximo de "45".
https://api.ninsaude.com/v1/prontuario_expressao/criar/lote/prontuario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9136,
    "error": []
}
 
ABRIR OBJETO
get
prontuario_expressao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_expressao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "paciente": 11558,
        "prontuario": 127875,
        "documento": null,
        "expressao": "car\u00e1lho"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_expressao/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_expressao/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_expressao
put
prontuario_expressao/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
paciente integer A propriedade "paciente" é obrigatória.
prontuario integer A propriedade "prontuario" é obrigatória.
documento integer
expressao alphaNumeric A propriedade "expressao" é obrigatória. A propriedade "expressao" deve possuir tamanho mínimo de "3" e máximo de "45".
https://api.ninsaude.com/v1/prontuario_expressao

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5157,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_expressao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_expressao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PRONTUÁRIOS prontuario_geral

 
LISTAR PRONTUÁRIOS
get
prontuario_geral/listar/paciente
get
prontuario_geral/listar/expressao/{expressao}
get
prontuario_geral/listar/paciente/{paciente}

Nome Tipo Descrição
paciente mixed Índice dos pacientes (optional).
cid mixed Índice dos CIDs (optional).
expressao mixed Índice das expressões (optional).
limite integer Quantidade máxima de ítens (optional).
offset integer Inicio do limite (optional).

 
LISTAR CIDS POR PACIENTE
get
prontuario_geral/listar/cid/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.

 
ENCERRAR PRONTUÁRIO
put
prontuario_geral/encerrar/prontuario/{prontuario}

Nome Tipo Descrição
prontuario integer Índice do prontuário.
https://api.ninsaude.com/v1/prontuario_geral/encerrar/prontuario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9720,
    "error": []
}
 
ABRIR OBJETO
get
prontuario_geral/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_geral/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_geral/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_geral/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_geral
put
prontuario_geral/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
paciente integer Apenas o profissional responsável pelo prontuário pode visualizá-lo. A propriedade "paciente" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
cid alphaNumeric A propriedade "cid" deve possuir tamanho mínimo de "3" e máximo de "5".
cid2 alphaNumeric A propriedade "cid2" deve possuir tamanho mínimo de "3" e máximo de "5".
cid3 alphaNumeric A propriedade "cid3" deve possuir tamanho mínimo de "3" e máximo de "5".
cid4 alphaNumeric A propriedade "cid4" deve possuir tamanho mínimo de "3" e máximo de "5".
data date A propriedade "data" é obrigatória.
horaInicial time
duracao decimal
encerrado boolean
confidencial boolean
retornoDia integer
retornoImportante boolean
note alphaNumeric
https://api.ninsaude.com/v1/prontuario_geral

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9813,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_geral/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_geral/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

GRÁFICOS DE PRONTUÁRIO prontuario_grafico

 
ESTADO CIVIL DOS PACIENTES
get
prontuario_grafico/listar/estadoCivil/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
FAIXA ETÁRIA DOS PACIENTES
get
prontuario_grafico/listar/faixaEtaria/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
RAÇA/COR DOS PACIENTES
get
prontuario_grafico/listar/racaCor/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
SEXO DOS PACIENTES
get
prontuario_grafico/listar/sexo/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
CID DOS PRONTUÁRIOS
get
prontuario_grafico/listar/cid/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
ALERGIAS DOS PRONTUÁRIOS
get
prontuario_grafico/listar/alergia/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
VACINAS DOS PRONTUÁRIOS
get
prontuario_grafico/listar/vacina/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
MEDICAMENTOS DOS PRONTUÁRIOS
get
prontuario_grafico/listar/medicamento/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
EXPRESSÕES DOS PRONTUÁRIOS
get
prontuario_grafico/listar/expressao/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
GRUPOS DE PACIENTES
get
prontuario_grafico/listar/grupo/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
CIDS E ÓRGÃOS DOS PRONTUÁRIOS
get
prontuario_grafico/abrir/cid/orgao/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
idadeInicial integer Idade inicial (optional).
idadeFinal integer Idade final (optional).
accountUnidade array Índice das unidades de atendimento (optional).

 
MÉDIA DE ATENDIMENTOS
get
prontuario_grafico/abrir/media/atendimento/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
MÉDIA DA PRESENÇA DOS AGENDAMENTOS
get
prontuario_grafico/abrir/media/presenca/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
MÉDIA DE SERVIÇOS DOS AGENDAMENTOS
get
prontuario_grafico/abrir/media/servico/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
MÉDIA DOS GASTOS DOS PACIENTES
get
prontuario_grafico/abrir/media/receita/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
accountUnidade array Índice das unidades de atendimento (optional).

 
ATENDIMENTOS DOS PACIENTES
get
prontuario_grafico/abrir/media/atendimento/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
PRESENÇA DOS PACIENTES
get
prontuario_grafico/abrir/media/presenca/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
SERVIÇOS DOS PACIENTES
get
prontuario_grafico/abrir/media/servico/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
GASTOS TOTAIS DO PACIENTE
get
prontuario_grafico/abrir/media/receita/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
PERFIL DOS AGENDAMENTOS DO PACIENTE
get
prontuario_grafico/abrir/perfil/agendamento/paciente/{paciente}

Nome Tipo Descrição
paciente integer Índice do paciente.
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
MAPA DE GEOLOCALIZAÇÃO
get
prontuario_grafico/listar/mapa/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
dataInicial string Data inicial.
dataFinal string Data final.
expressao array Expressões (optional).
cid array CIDs (optional).
accountUnidade array Índice das unidades de atendimento (optional).

 

NOTAS DE PRONTUÁRIO prontuario_nota

 
LISTAR NOTAS
get
prontuario_nota/listar
get
prontuario_nota/listar/alergia/{alergia}
get
prontuario_nota/listar/documento/{documento}
get
prontuario_nota/listar/prontuario/{prontuario}
get
prontuario_nota/listar/anamnese/{anamnese}

Nome Tipo Descrição
alergia mixed Índice das alergias (optional).
documento mixed Índice dos documentos (optional).
prontuario mixed Índice dos prontuários (optional).
anamnese mixed Índice das anamneses (optional).

 
ABRIR OBJETO
get
prontuario_nota/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_nota/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "paciente": 11558,
        "profissional": 1,
        "prontuario": 128507,
        "documento": null,
        "anamnese": null,
        "alergia": null,
        "note": "eeeee",
        "data": "2017-11-17",
        "hora": "15:48:08"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_nota/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_nota/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_nota
put
prontuario_nota/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
paciente integer A propriedade "paciente" é obrigatória.
profissional integer A propriedade "profissional" é obrigatória.
prontuario integer
documento integer
anamnese integer
alergia integer
note alphaNumeric A propriedade "note" é obrigatória.
data date A propriedade "data" é obrigatória.
hora time A propriedade "hora" é obrigatória.
https://api.ninsaude.com/v1/prontuario_nota

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 3400,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_nota/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_nota/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

PRESCRIÇÕES prontuario_prescricao

 
LISTAR
get
prontuario_prescricao/listar
get
prontuario_prescricao/listar/prontuario/{prontuario}

Nome Tipo Descrição
prontuario integer Índice do prontuário (optional).
filter mixed Filtro nativo do framework (optional).

 
IMPORTAR MODELO
post
prontuario_prescricao/importar/modelo/prontuario/{prontuario}/modelo/{modelo}

Nome Tipo Descrição
id integer
prontuario integer A propriedade "prontuario" é obrigatória.
documentoModelo integer A propriedade "documentoModelo" é obrigatória.
documentoProntuario integer

Notice: Undefined index: {modelo} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/prontuario_prescricao/importar/modelo/prontuario/1/modelo/ Content-type: application/json Authorization: bearer <<access_token>> { "result": 8476, "error": [] }
 
ADICIONAR MODELO
post
prontuario_prescricao/adicionar/modelo/prescricao/{prescricao}

Nome Tipo Descrição
id integer
prontuario integer A propriedade "prontuario" é obrigatória.
documentoModelo integer A propriedade "documentoModelo" é obrigatória.
documentoProntuario integer

Notice: Undefined index: {prescricao} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/prontuario_prescricao/adicionar/modelo/prescricao/ Content-type: application/json Authorization: bearer <<access_token>> { "result": 8917, "error": [] }
 
ADICIONAR DOCUMENTO NO PRONTUÁRIO
post
prontuario_prescricao/adicionar/documento/prontuario/prescricao/{prescricao}

Nome Tipo Descrição
id integer
prontuario integer A propriedade "prontuario" é obrigatória.
documentoModelo integer A propriedade "documentoModelo" é obrigatória.
documentoProntuario integer

Notice: Undefined index: {prescricao} in C:\xampp\htdocs\apolo\documentos\geraDocumentacao.php on line 347
https://api.ninsaude.com/v1/prontuario_prescricao/adicionar/documento/prontuario/prescricao/ Content-type: application/json Authorization: bearer <<access_token>> { "result": 1665, "error": [] }
 
ABRIR OBJETO
get
prontuario_prescricao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_prescricao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "prontuario": 127875,
        "documentoModelo": 33,
        "documentoProntuario": 310
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_prescricao/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_prescricao/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_prescricao
put
prontuario_prescricao/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
prontuario integer A propriedade "prontuario" é obrigatória.
documentoModelo integer A propriedade "documentoModelo" é obrigatória.
documentoProntuario integer
https://api.ninsaude.com/v1/prontuario_prescricao

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 8136,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_prescricao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_prescricao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

MEDICAMENTOS DA PRESCRIÇÃO prontuario_prescricaomedicamento

 
LISTAR
get
prontuario_prescricaomedicamento/listar
get
prontuario_prescricaomedicamento/listar/prontuario/{prontuario}
get
prontuario_prescricaomedicamento/listar/prontuario/{prontuario}/dataInicial/{dataInicial}/dataFinal/{dataFinal}
get
prontuario_prescricaomedicamento/listar/prescricao/{prescricao}
get
prontuario_prescricaomedicamento/listar/prescricao/{prescricao}/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
prescricao mixed Índice das prescrições (optional).
prontuario mixed Índice dos prontuários (optional).
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).
medicamento integer Medicamento (optional).
viaAdministracao mixed Vias de administração (optional).
tratamentoTipo mixed Tipos de tratamento (optional).
dosagemTipo mixed Tipos de dosagem (optional).
frequenciaTipo mixed Tipos de frequência (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
prontuario_prescricaomedicamento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_prescricaomedicamento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "prescricao": 30,
        "medicamento": 57089,
        "data": "2017-10-27",
        "viaAdministracao": 1,
        "tratamentoQuantidade": null,
        "tratamentoTipo": 1,
        "dosagemQuantidade": null,
        "dosagemTipo": 1,
        "frequenciaQuantidade": null,
        "frequenciaTipo": 1,
        "observacao": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_prescricaomedicamento/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_prescricaomedicamento/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_prescricaomedicamento
put
prontuario_prescricaomedicamento/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
prescricao integer A propriedade "prescricao" é obrigatória.
medicamento integer A propriedade "medicamento" é obrigatória.
data date A propriedade "data" é obrigatória.
viaAdministracao integer A propriedade "viaAdministracao" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17".
tratamentoQuantidade integer
tratamentoTipo integer A propriedade "tratamentoTipo" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7, 8".
dosagemQuantidade integer
dosagemTipo integer A propriedade "dosagemTipo" deve possuir um dos valores da lista "1, 2, 3, 4, 5".
frequenciaQuantidade integer
frequenciaTipo integer A propriedade "frequenciaTipo" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6, 7".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "3" e máximo de "250".
https://api.ninsaude.com/v1/prontuario_prescricaomedicamento

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 4456,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_prescricaomedicamento/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_prescricaomedicamento/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

VACINAS prontuario_vacina

 
LISTAR VACINAS
get
prontuario_vacina/listar/paciente/{paciente}
get
prontuario_vacina/listar/paciente/{paciente}/status/{status}

Nome Tipo Descrição
paciente integer Índice do paciente.
status integer Status (optional).

 
ALTERAR STATUS
put
prontuario_vacina/alterar/status/vacina/{vacina}

Nome Tipo Descrição
vacina mixed Índices das vacinas.
novoStatus integer Novo status.
https://api.ninsaude.com/v1/prontuario_vacina/alterar/status/vacina/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9202,
    "error": []
}
 
ABRIR OBJETO
get
prontuario_vacina/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_vacina/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "prontuario": 127874,
        "vacina": 9,
        "status": 3,
        "idade": null,
        "idadeTipo": null,
        "dataImunizacao": "2017-10-23",
        "dosagem": 1,
        "lote": null,
        "observacao": null
    },
    "error": []
}
 
BUSCAR OBJETOS
get
prontuario_vacina/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
prontuario_vacina/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
prontuario_vacina
put
prontuario_vacina/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
prontuario integer A propriedade "prontuario" é obrigatória.
vacina integer A propriedade "vacina" é obrigatória.
status integer A propriedade "status" é obrigatória. A propriedade "status" deve possuir um dos valores da lista "1, 2, 3".
idade integer
idadeTipo integer A propriedade "idadeTipo" deve possuir um dos valores da lista "1, 2, 3".
dataImunizacao date A propriedade "dataImunizacao" é obrigatória.
dosagem integer A propriedade "dosagem" deve possuir um dos valores da lista "1, 2, 3, 4, 5, 6".
lote alphaNumeric A propriedade "lote" deve possuir tamanho mínimo de "1" e máximo de "50".
observacao alphaNumeric A propriedade "observacao" deve possuir tamanho mínimo de "1" e máximo de "250".
https://api.ninsaude.com/v1/prontuario_vacina

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 9691,
    "error": []
}
 
EXCLUIR OBJETO
delete
prontuario_vacina/{id:^[0-9]++$}

https://api.ninsaude.com/v1/prontuario_vacina/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

CONFIGURAÇÕES DOS WIDGETS widget_configuracao

 
LISTAR CONFIGURAÇÕES
get
widget_configuracao/listar
get
widget_configuracao/listar/usuario/{usuario}

Nome Tipo Descrição
usuario mixed Índice dos usuários (optional).

 
ALTERAR POSIÇÃO DO WIDGET
put
widget_configuracao/alterar/posicao/configuracao/{configuracao}

Nome Tipo Descrição
alinhamentoHorizontal integer Alinhamento na horizontal.
alinhamentoVertical integer Alinhamento na vertical.
https://api.ninsaude.com/v1/widget_configuracao/alterar/posicao/configuracao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 29,
    "error": []
}
 
ADICIONAR CONFIGURAÇÃO EM LOTE
post
widget_configuracao/adicionar/lote

Nome Tipo Descrição
id integer
usuario integer A propriedade "usuario" é obrigatória.
widget integer A propriedade "widget" é obrigatória.
alinhamentoHorizontal integer A propriedade "alinhamentoHorizontal" é obrigatória. A propriedade "alinhamentoHorizontal" deve possuir um dos valores da lista "1, 2, 3".
alinhamentoVertical integer A propriedade "alinhamentoVertical" é obrigatória. A propriedade "alinhamentoVertical" deve possuir valor compatível com a expressão "alinhamentoVertical > 0".
https://api.ninsaude.com/v1/widget_configuracao/adicionar/lote

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2430,
    "error": []
}
 
ABRIR OBJETO
get
widget_configuracao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_configuracao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "usuario": 18,
        "widget": 1,
        "alinhamentoHorizontal": 1,
        "alinhamentoVertical": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
widget_configuracao/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
widget_configuracao/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
widget_configuracao
put
widget_configuracao/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
usuario integer A propriedade "usuario" é obrigatória.
widget integer A propriedade "widget" é obrigatória.
alinhamentoHorizontal integer A propriedade "alinhamentoHorizontal" é obrigatória. A propriedade "alinhamentoHorizontal" deve possuir um dos valores da lista "1, 2, 3".
alinhamentoVertical integer A propriedade "alinhamentoVertical" é obrigatória. A propriedade "alinhamentoVertical" deve possuir valor compatível com a expressão "alinhamentoVertical > 0".
https://api.ninsaude.com/v1/widget_configuracao

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5281,
    "error": []
}
 
EXCLUIR OBJETO
delete
widget_configuracao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_configuracao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

WIDGETS DO TIPO FEED widget_feed

 
LISTAR FEEDS
get
widget_feed/listar
get
widget_feed/listar/feed/configuracao/{configuracao}

Nome Tipo Descrição
configuracao mixed Índice das configurações (optional).
descricao string Descrição (optional).
url string URL (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
LISTAR FEEDS POR URL
get
widget_feed/listar/feed/url

Nome Tipo Descrição
url string URL.

 
LISTAR FEED DE UMA CONFIGURAÇÃO/URL
get
widget_feed/listar/noticia/feed/{feed}
get
widget_feed/listar/noticia/url

Nome Tipo Descrição
feed string Índice do feed (optional).
url string URL (optional).
limite integer Número máximo de itens (optional).

 
ADICIONAR FEEDS EM LOTE
post
widget_feed/adicionar/lote

Nome Tipo Descrição
id integer
configuracao integer A propriedade "configuracao" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "1" e máximo de "250".
url url A propriedade "url" é obrigatória. A propriedade "url" deve possuir tamanho mínimo de "3" e máximo de "250".
https://api.ninsaude.com/v1/widget_feed/adicionar/lote

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5644,
    "error": []
}
 
ABRIR OBJETO
get
widget_feed/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_feed/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "configuracao": 8,
        "descricao": "nyt",
        "url": "http:\/\/www.nytimes.com\/services\/xml\/rss\/nyt\/HomePage.xml"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
widget_feed/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
widget_feed/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
widget_feed
put
widget_feed/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
configuracao integer A propriedade "configuracao" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "1" e máximo de "250".
url url A propriedade "url" é obrigatória. A propriedade "url" deve possuir tamanho mínimo de "3" e máximo de "250".
https://api.ninsaude.com/v1/widget_feed

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2760,
    "error": []
}
 
EXCLUIR OBJETO
delete
widget_feed/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_feed/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

WIDGETS DE SUGESTÃO DE FUNCIONALIDADES widget_sugestao

 
LISTAR SUGESTÕES
get
widget_sugestao/listar
get
widget_sugestao/listar/usuario/{usuario}

Nome Tipo Descrição
account mixed Índice dos accounts (optional).
usuario mixed Índice dos usuários (optional).
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).
status string Status da sugestão (optional).
descricao string Filtro de pesquisa por descrição (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR SUGESTÕES RANDOMICAS
get
widget_sugestao/abrir/randomico


 
ABRIR OBJETO
get
widget_sugestao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_sugestao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "usuario": 2,
        "data": "2017-09-15",
        "hora": "10:58:03",
        "status": 0,
        "area": 0,
        "descricao": "weqeweqeewe"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
widget_sugestao/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
widget_sugestao/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
widget_sugestao
put
widget_sugestao/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
usuario integer A propriedade "usuario" é obrigatória.
data date A propriedade "data" é obrigatória.
hora time A propriedade "hora" é obrigatória.
status integer A propriedade "status" é obrigatória.
area integer A propriedade "area" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "1000".
https://api.ninsaude.com/v1/widget_sugestao

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 2303,
    "error": []
}
 
EXCLUIR OBJETO
delete
widget_sugestao/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_sugestao/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

COMENTÁRIOS DAS SUGESTÕES widget_sugestaocomentario

 
LISTAR COMENTÁRIOS
get
widget_sugestaocomentario/listar/sugestao/{sugestao}/accountSugestao/{accountSugestao}
get
widget_sugestaocomentario/listar/sugestao/{sugestao}/accountSugestao/{accountSugestao}/dataInicial/{dataInicial}/dataFinal/{dataFinal}
get
widget_sugestaocomentario/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
sugestao integer Índice da sugestão (optional).
accountSugestao integer Índice do account da sugestão (optional).
usuario mixed Índice dos usuários (optional).
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).
filter mixed Filtro de pesquisa nativo do framework (optional).

 
ABRIR OBJETO
get
widget_sugestaocomentario/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_sugestaocomentario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "sugestao": 3,
        "accountSugestao": 2,
        "usuario": 2,
        "data": "2017-09-13",
        "hora": "13:36:31",
        "descricao": "qweqweqew"
    },
    "error": []
}
 
BUSCAR OBJETOS
get
widget_sugestaocomentario/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
widget_sugestaocomentario/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
widget_sugestaocomentario
put
widget_sugestaocomentario/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
sugestao integer A propriedade "sugestao" é obrigatória.
accountSugestao integer A propriedade "accountSugestao" é obrigatória.
usuario integer A propriedade "usuario" é obrigatória.
data date A propriedade "data" é obrigatória.
hora time A propriedade "hora" é obrigatória.
descricao alphaNumeric A propriedade "descricao" é obrigatória. A propriedade "descricao" deve possuir tamanho mínimo de "3" e máximo de "1000".
https://api.ninsaude.com/v1/widget_sugestaocomentario

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": 5888,
    "error": []
}
 
EXCLUIR OBJETO
delete
widget_sugestaocomentario/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_sugestaocomentario/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": true,
    "error": []
}
 

VOTOS DAS SUGESTÕES widget_sugestaovoto

 
LISTAR VOTOS
get
widget_sugestaovoto/listar/sugestao/{sugestao}/accountSugestao/{accountSugestao}
get
widget_sugestaovoto/listar/sugestao/{sugestao}/accountSugestao/{accountSugestao}/dataInicial/{dataInicial}/dataFinal/{dataFinal}
get
widget_sugestaovoto/listar/dataInicial/{dataInicial}/dataFinal/{dataFinal}

Nome Tipo Descrição
sugestao integer Índice da sugestão (optional).
accountSugestao integer Índice do account das sugestões (optional).
usuario mixed Índice dos usuários (optional).
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
ABRIR SUGESTÃO
get
widget_sugestaovoto/abrir/sugestao/{sugestao}/accountSugestao/{accountSugestao}/usuario/{usuario}

Nome Tipo Descrição
sugestao integer Índice da sugestão (optional).
accountSugestao integer Índice do account das sugestões (optional).
usuario mixed Índice dos usuários (optional).
dataInicial string Data inicial (optional).
dataFinal string Data final (optional).

 
ABRIR OBJETO
get
widget_sugestaovoto/{id:^[0-9]++$}

https://api.ninsaude.com/v1/widget_sugestaovoto/1

Content-type: application/json
Authorization: bearer <<access_token>>

{
    "result": {
        "id": null,
        "sugestao": 2,
        "accountSugestao": 2,
        "usuario": 2,
        "data": "2017-09-20",
        "hora": "09:03:53",
        "tipo": 1
    },
    "error": []
}
 
BUSCAR OBJETOS
get
widget_sugestaovoto/listar/{filter}


 
OBTER DESCRIÇÃO DE UM OBJETO DO MODEL VINCULADO AO CONTROLLER
get
widget_sugestaovoto/getDescriptionValue/{id}


 
SALVAR OBJETOS
post
widget_sugestaovoto
put
widget_sugestaovoto/{id:^[0-9]++$}

Nome Tipo Descrição
id integer
sugestao integer A propriedade "sugestao" é obrigatória.
accountSugestao integer A propriedade "accountSugestao" é obrigatória.
usuario integer<