Histórico da Página

...

Bloco de código

title	JSON Solicitação POST
collapse	true

{
    "message": "Protocolo criado com sucesso",
    "success": true,
    "protocolo": "000000023675"
}

05. ATRIBUTOS DE RESPOSTA

Solicitação GET

...

Solicitação POST

...

Atributo

...

Campo

...

Tipo

...

Campo fixo que indica a ação encontrada: 0001

...

Mensagem indicativa referente ao código acima:

0001 - Pedido de inclusao gerado com sucesso

0002 - Não foi encontrada guia, e possível realizar o reenvio

...

06. EXEMPLOS DE JSON DE RESPOSTA

Solicitação GET:

Bloco de código

title	Sucesso 202 - Corpo Clínico encontrado
collapse	true

{
    "items": [
        {
            "idOnHealthInsurer": "000008",
            "professionalCouncil": "",
            "professionalCouncilNumber": "",
            "id": 8,
            "name": "",
            "stateAbbreviation": ""
        },
        {
            "idOnHealthInsurer": "000005",
            "professionalCouncil": "",
            "professionalCouncilNumber": "",
            "id": 9,
            "name": "",
            "stateAbbreviation": ""
        },
        {
            "idOnHealthInsurer": "000003",
            "professionalCouncil": "CRM",
            "professionalCouncilNumber": "555555",
            "id": 10,
            "name": "RDA CLAUDIA",
            "stateAbbreviation": "SP"
        },
        {
            "idOnHealthInsurer": "",
            "professionalCouncil": "CRM",
            "professionalCouncilNumber": "654987",
            "id": 11,
            "name": "DAIANE BERNARDE BATISTA",
            "stateAbbreviation": "SP"
        },
        {
            "idOnHealthInsurer": "",
            "professionalCouncil": "CRO",
            "professionalCouncilNumber": "321987",
            "id": 12,
            "name": "ALMIRO NOGUEIRA FILHO",
            "stateAbbreviation": "SP"
        },
        {
            "idOnHealthInsurer": "000007",
            "professionalCouncil": "CRM",
            "professionalCouncilNumber": "19011985",
            "id": 13,
            "name": "RDA SILVIA SANT ANNA",
            "stateAbbreviation": "SP"
        }
    ],
    "hasNext": false
}

Bloco de código

title	Falha 202 - Corpo clínico não encontrado
collapse	true

{
    "code": 400,
    "message": "Registros nao encontrados",
    "detailedMessage": "Nao foi encontrado o corpo clinico para os parametros informados",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

Solicitação POST:

Bloco de código

title	Sucesso - Inclusão de pedido gerado com sucesso
collapse	true

{
    "code": "0001",
    "message": "Pedido de inclusao gerado com sucesso: 000030"
}

Bloco de código

title	Falha 202 - Inclusão de pedido não processada
collapse	true

{
    "code": 400,
    "message": "Falha ao criar pedido",
    "detailedMessage": "Nao foi possivel gerar o pedido de inclusao de Profissional no Corpo Clinico",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

Solicitação PUT - Bloqueio de Profissional

Sucesso - HTTP Status 200

Bloco de código

title	Falha 202 - Id não encontrado
collapse	true

{
    "code": 400,
    "message": "Registros nao encontrados",
    "detailedMessage": "Nao foi encontrado corpo clinico com o id informado",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

05. ATRIBUTOS DE RESPOSTA

06. EXEMPLOS DE JSON DE RESPOSTA