...
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
exemplo.com / aps/curso/inscricao | POST | application/json |
Parâmetros de entrada
...
Parâmetro | Obrigatório | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
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 |
|
idTipoAtendimento | C | String | Código identificador do tipo de atendimento | Obrigatorio quando for atraves da realizacao de uma atividade |
idAtividade | C | String | Código identificador da atividade | Obrigatorio quando for atraves da realizacao de uma atividade |
idAtendimento | C | String | Código identificador do atendimento | Obrigatorio quando for atraves da realizacao de uma atividade |
idCurso | M | String | Código identificador do tipo de atendimento | |
idTurma | M | String | Código identificador do questionario cadastrado no previva |
...
| Bloco de código |
|---|
{
"chaveUnica": "101012",
"integracao": {
"cpf": "123456789123",
"numero_cartao": "9288701",
},
"beneficiario": {
"chaveUnica": "101012", //geralmente é o cpf
"numeroContrato": "616161",
"integracao": {
"cpf": "123456789123",
"numero_cartao": "9288701",
},
},
"idTipoAtendimento": "39",
"idAtividade":"39",
"idAtendimento":"39",
"idTurma":"39",
"idCurso": "1",
} |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
protocolo | M | String | Numero de protocolo gerado pelo sistema da PREVIVA. |
|
mensagem | M | String | Mensagem amigável que será exibida para o usuário |
|
...
...
|
Retorno da API - Sucesso
| Bloco de código |
|---|
{
"protocolo": "123",
"mensagem": "Sucesso!"
} |
...