Consultar e criar origens

A origem de cadastro indica como o paciente chegou à clínica: indicação, Google, Instagram, entre outros. Ela alimenta o campo idOrigem do cadastro de paciente.

Operação	Finalidade
GET /origem/lista	Listar as origens e seus identificadores (idOrigem)
POST /origem/novo	Criar uma origem

Esta lista corresponde às origens do cadastro de paciente. As origens do agendamento estão em GET /agenda/origem, utilizadas no campo idOrigemPaciente.

Listar

curl -G "https://api.clinicanasnuvens.com.br/origem/lista" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  --data-urlencode "registrosPorPagina=50"

{
  "lista": [
    { "id": 5, "ativo": true, "nome": "Instagram" },
    { "id": 6, "ativo": true, "nome": "Indicação" }
  ],
  "pagina": 0,
  "totalPaginas": 1
}

A listagem retorna apenas as origens ativas, portanto o campo ativo da resposta é sempre true. A consulta aceita os parâmetros de paginação.

Criar

curl -X POST "https://api.clinicanasnuvens.com.br/origem/novo" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{ "nome": "Campanha de outubro" }'

Campos da requisição

Campo	Tipo	Obrigatório	Descrição
nome	String	Sim	Nome da origem, com até 50 caracteres

Resposta:

{ "id": 7, "ativo": true, "nome": "Campanha de outubro" }

O corpo da requisição tem um único campo, o nome. A origem é criada ativa e do tipo cadastro de paciente.

Regras de criação

• Nomes repetidos não são validados: cada chamada cria um novo registro.
• Origens criadas não podem ser alteradas nem excluídas pela API.
• O nome aceita até 50 caracteres, e nomes maiores são recusados.

Onde o identificador é usado

Campo	Onde
idOrigem	Opcional ao criar e ao alterar um paciente

Ver Cadastrar um paciente.

Veja na Referência

Os detalhes de cada operação, campo a campo, estão em Referência › Origens de cadastro.