...
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
exemplo.com / aps/locaisAtendimento | POST | application/json | Endpoint responsavel por realizar a adesão no programa de APS |
Parâmetros de entrada
Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.
Serão enviados no BODY os seguintes parâmetros:
Parâmetro | Obrigatório | Tipo | Descrição |
|
|---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
|
integracao | OP | Objeto | Nó integração retornado no login do usuário |
|
beneficiario | M | Objeto | Beneficiario selecionado para agendamento da consulta |
|
idAtendimento | M | Number | ID do atendimento cadastrada pelo PREVIVA | |
idAtividade | M | Number | ID da atividade cadastrada pelo PREVIVA |
|
idTipoAtividade | OP | Number | ID do tipo de atividade cadastrado pelo PREVIVA |
|
dataReferencia | OP | String |
| |
IdTipoAtendimento | OP | Number | ID do tipo de atendimento cadastrado pelo PREVIVA | ID do tipo de atendimento selecionado na etapa de seleção de tipo de consulta. Identifica o tipo de consulta:
|
idRegiao | OP | Number | ID da região cadastrado pelo previva. |
|
| Bloco de código |
|---|
{
"chaveUnica":"String",
"integracao":{ Objeto },
"beneficiario":{ Objeto }
},
"dataReferencia": "String"
"idAtividade:": "Number",
"idTipoAtividade": "Number"
"idTipoAtendimento": "Number",
"idRegiao": "Number"
} |
Objeto beneficiario
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do paciente |
|
numeroContrato | M | String | Número do contrato do paciente |
|
integracao | OP | Objeto | Nó integração retornado no login do usuário |
|
| Bloco de código |
|---|
{
"beneficiario":{
"chaveUnica":"String",
"numeroContrato":"String",
"integracao":{ Objeto }
} |
...
Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
locais | M | Array de objetos do tipo "locais" |
|
|
alerta | OP | String | Texto de alerta geral dos locais de atendimento | Texto Livre |
| Bloco de código |
|---|
{
"alerta": "String"
"locais": [ "Objeto" ],
} |
Objeto locais
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
descricao | M | String | Texto de descrição do local de atendimento | Texto livre |
id | M | String | id do local de atendimento |
|
endereco | M | Objeto | Objeto com dados do endereço | Objeto endereço |
contatos | M | Array | Array de objetos do tipo contato | Array de objeto contato |
alerta | OP | String | Texto de alerta do local de atendimento | Texto Livre |
quantidadeMedicos | OP | String | Quantidades de médicos disponíveis para atendimento |
|
| Bloco de código |
|---|
{
"locais":[
{
"descricao":"String",
"id":"String",
"alerta":"String",
"endereco":{ objeto },
"contatos": [ Array-objetos ],
"quantidadeMedicos": "String"
} |
Objeto endereco
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
endereco | M | String | Texto de endereço do local de atendimento | Texto livre |
numero | M | String | Número do local de atendimento | Texto livre |
complemento | M | String | Complemento do local de atendimento | Texto livre |
bairro | M | String | Bairro do local de atendimento | Texto livre |
cidade | M | String | Cidade do local de atendimento | Texto livre |
estado | M | String | Estado do local de atendimento | Texto livre |
| Bloco de código |
|---|
{
"locais":[
{
"endereco":{
"endereco":"String",
"numero":"String",
"complemento":"String",
"bairro":"String",
"cidade":"String",
"estado":"String"
}
} |
Objeto contato
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
tipo | M | String | Tipo de contato | Conteúdo válido: |
id | M | String | id do contato |
|
titulo | M | String | Titulo do contato | EX: “Telefone" |
valor | M | String | Valor do contato | EX:”28 999999999" |
| Bloco de código |
|---|
{
"locais":[
{
"contatos": [ {
"tipo":"String",
"titulo":"String",
"valor":"String"
}
]
} |
...