Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações

Endpoint

Endpoint

Método

Header Content-Type

Descrição

exemplo.com / aps/atividades

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/aps/atividades

POST

application/json

Endpoint responsavel por realizar a adesão no programa de APS

...

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

codigo

M

Numer

Codigo identificador do tipo de atividade

 

descricao

M

String

Descrição do tipo de atividade

 

classificacaoTipoAtividade

M

Objeto

 Objeto do tipo "classificacaoTipoAtividade"

classificação do tipo de atividade

Bloco de código
{
    "tipoAtendimentotipoAtividade": {
        "codigo": "string", 
        "descricao":"string",
        "classificacaoTipoAtendimentoclassificacaoTipoAtividade":{
            "codigo":"string", 
            "descricao":"string"
        }
    },
}

...

Bloco de código
languagejson
{
    "atividades": [
      {
        "codigoAtividade": 123,
        "codigoAtendimento": 123,
        "numeroProtocolo": "123",
        "titulo": "Médico - Agendar consulta",
        "descricao": null, 
        "programa":{
          "codigo":11023,
          "titulo": "Atendimento Primário a Saúde",
          "descricao": "A linha de cuidado atendimento primário a saúde é a linha de cuidado que...", //Parametro opcional
          "icone":"<link da imagem>",
          "grupo":{
              "codigo": 123,
              "titulo": "Atendimento Primário a Saúde",
              "descricao": "Grupo Xpto",
              "icone":"<link da imagem>",
              "subgrupo":{
                "codigo":123,
                "titulo": "Atendimento Primário a Saúde",
                "descricao": "xpto",
                "icone":"<link da imagem>",
              },
            },
        },
        "situacao":{
          "codigo": 123,
          "descricao": "agendado"
        },
        "dataSugerida": "01/02/2024 09:00:00",
        "dataRealizado":"01/02/2024 09:00:00",
        "tipoAtendimento": {
            "codigo":25, 
            "descricao":"descricao do tipo de atendimenot",
            "classificaoTipoAtendimentoclassificacaoTipoAtendimento":{
                "codigo":123, 
                "descricao":"Agendamento"
            }
        },
        "tipoAtividade": {
            "codigo":123, 
            "descricao":"descricao do tipo de atividade",
            "classificaoTipoAtividadeclassificacaoTipoAtividade":{
                "codigo":123, 
                "descricao":"Agendamento"
            }
        },
    ]
}

...

Aviso