Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Protocols - Inclusão de protocolo de autorização
2. Protocols - Retorna os protocolos de autorização do beneficiário
3. Protocols/interactions - Retorna as interações do protocolo de autorização
4. Protocols/attachments Authorizations/protocols - Inclusão de anexos no protocolo de autorização
Tela api authorizations
1. Outras Ações / Ações relacionadas
Tela XXX
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

Painel

titleColor	Orange
borderStyle	solid
title	Authorizations/protocols Protocols - Inclusão de protocolo de autorização

Realiza a inclusão de um protocolo de solicitação de autorização para operadora.

/totvsHealthPlans/attendance/v1/authorizations/protocols

POST

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required

Dica

Expandir

title	Request

subscriberId	string	Matricula do beneficiário solicitante do protocolo de autorização (obtido através da API Beneficiaries - v1.000 (Family Contract))	BKU_MATUSR	*required
stateAbbreviation	string	Estado do conselho regional do profissional de saúde solicitante	BKU_UF
professionalCouncil	string	Sigla do conselho regional do profissional de saúde solicitante (obtido através da API RegionalCouncils - v1.000 (Attendance Network))	BKU_SIGLA
professionalCouncilNumber	string	Numero do conselho regional do profissional de saúde solicitante	BKU_REGSOL
professionalName	string	Nome do profissional de saúde solicitante (obtido através da API Professionals - v1.000 (Attendance Network))	BKU_NOMSOL	*required
attachments	array	Anexos da solicitação de autorização		*required
attachments.href	string	Url do arquivo para que seja realizado o download		*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
	"subscriberId" : "00011008000027010",
	"stateAbbreviation" : "SP",
	"professionalCouncil" : "CRM",
	"professionalCouncilNumber" : "1234567",
	"professionalName" : "VINICIUS",
	"attachments" : [
        {
            "href" : "https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg"
        }
	]
}

Dica

Expandir

title	(201) - Operação realizada com sucesso

protocol	string	Numero do protocolo gerado para a solicitação de autorização	BKU_NRPRO	*required
name	string	Nome do beneficiário solicitante	BKU_NOMUSR	*required
subscriberId	string	Matricula do beneficiário solicitante	BKU_MATUSR	*required
professionalName	string	Nome do profissional solicitante	BKU_NOMSOL	*required
stateAbbreviation	string	Estado do conselho regional do profissional solicitante	BKU_UF
professionalCouncil	string	Sigla do conselho regional do profissional solicitante	BKU_SIGLA
professionalCouncilNumber	string	Numero do conselho regional do profissional solicitante	BKU_REGSOL
status	string	Status do protocolo de solicitação de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento	BKU_STATUS
idOnHealthInsurer	string	Numero da autorização gerada pelo sistema depois de aprovada a solicitação.	BKU_NUMAUT
authType	string	Tipo da solicitação, sendo: 2 = SADT 3 = Internação 4 = Odontológico	BKU_TIPO

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "protocol": "41750520230620000003",
    "name": "HERNANDES ALVES DA SILVA",
    "subscriberId": "00011008000027010",
    "professionalName": "VINICIUS",
    "stateAbbreviation": "SP",
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "1234567",
    "status": "7",
    "idOnHealthInsurer": "",
    "authType": ""
}

Aviso

Expandir

title	(406) - Json do body invalido

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"professionalCouncilNumber\" : \"1234567\",\r\n\t\"professionalName\" : \"VINICIUS\",\r\n\t\"attachments\" : [\r\n        {\r\n            \"href\" : \"https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg\"\r\n        }\r\n\t]\r\n}<<"
}

Aviso

Expandir

title	(406) - Campos inválidos

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo professionalCouncilNumber",
            "detailedMessage": "O valor do campo professionalCouncilNumber deve ser do tipo (C)."
        },
        {
            "code": "E002B-406",
            "message": "Campo professionalName obrigatório",
            "detailedMessage": "Não foi informado valor do campo professionalName."
        }
    ]
}

Aviso

Expandir

title	(404) - Beneficiário não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E003",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027011"
}

Aviso

Expandir

title	(400) - Dados inválidos

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E004",
    "message": "Erro ao incluir protocolo de autorização",
    "detailedMessage": "Verifique a lista de erros para mais detalhes",
    "details": [
        {
            "code": "E004-1",
            "message": "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://img.olhardigital.com.br/wp-content/ploads/2019/01/20190115163721.jpg"
        }
    ]
}

Âncora

	protocolsGet
	protocolsGet

Painel

titleColor	Orange
borderStyle	solid
title	Protocols - Retorna os protocolos de autorização do beneficiário

Retorna os protocolos de solicitação de autorização do beneficiário.

/totvsHealthPlans/attendance/v1/authorizations/{subscriberId}/protocols

GET

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
subscriberId (path)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) (obtido através da API Beneficiaries - v1.000 (Family Contract))	*required
protocol (query)	string	Filtro pelo numero do protocolo (BKU_NRPRO)
status (query)	string	Filtro pelo status do protocolo de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento pode ser enviado mais de um status. Exemplo: 1,2,3
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de protocolos de reembolso retornados
items.protocol	string	Numero do protocolo gerado para a solicitação de autorização	BKU_NRPRO	*required
items.name	string	Nome do beneficiário solicitante	BKU_NOMUSR	*required
items.subscriber-id	string	Matricula do beneficiário solicitante	BKU_MATUSR	*required
items.professional-name	string	Nome do profissional solicitante	BKU_NOMSOL	*required
items.professional-council	string	Sigla do conselho regional do profissional solicitante	BKU_SIGLA
items.professional-council-number	string	Numero do conselho regional do profissional solicitante	BKU_REGSOL
items.status	string	Status do protocolo de solicitação de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento	BKU_STATUS
items.id-on-health-insurer	string	Numero da autorização gerada pelo sistema depois de aprovada a solicitação	BKU_NUMAUT
items.auth-type	string	Tipo da solicitação, sendo: 2 = SADT 3 = Internação 4 = Odontológico	BKU_TIPO

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "protocol": "41750520230601000030",
            "name": "HERNANDES ALVES DA SILVA",
            "subscriber-id": "00011008000027010",
            "professional-name": "ANDRE",
            "professional-council": "CRM",
            "professional-council-number": "334455",
            "status": "7",
            "id-on-health-insurer": "",
            "auth-type": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 3
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave subscriberId obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave subscriberId."
        }
    ]
}

Aviso

Expandir

title	(404) - Beneficiário não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

03. TELA AUTHORIZATIONS

Outras Ações / Ações relacionadas

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

03. TELA AUTHORIZATIONS