Powered by Redocly

Document

Rota responsável por retornar os termos jurídicos mais atualizados

SecurityoAuth2ClientCredentials
Request
path Parameters
term
required
integer <int32> (TermFileEnum)

Exemplo (1 para termo de uso; 2 para política de privacidade; 3 para condições comerciais)

Enum: 1 2 3
version
required
string
query Parameters
networkId
integer <int32>
Responses
200

Retorna o arquivo de termos

400

Não foi possível retornar o arquivo de termos

404

Term file not found

get/api/v1/{term}/accepted-terms/documents
Response samples
application/json
"string"

Rota responsável pelo upload de um documento de um paciente

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
documentTypeId
required
integer <int32>
Request Body schema: multipart/form-data

Para envio de ficheiro deve ser feita uma requisição do tipo multipart/form-data com nome da propriedade sendo file. Tipos de ficheiro aceitavel(jpg, png, jpeg,pdf,doc,xls,docx,xlsx,odt,ods).

file
string <binary>
Responses
200

Return a document uploaded

400

Unable to return a document uploaded due to validation error

post/api/v1/users/{userId}/documentTypes/{documentTypeId}/documents
Response samples
application/json
[
  • {
    }
]

Rota responsável por devolver um documento para um usuário

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
version
required
string
Responses
200

Devolver um documento para um usuário

400

Não é possível retornar um documento de usuário com este ID devido a erro de validação

404

Nenhum documento cadastrado por este usuário no sistema foi encontrado

get/api/v{version}/users/{userId}/documents
Response samples
application/json
[
  • {
    }
]

Rota responsável pelo upload do documento de uma clínica.

SecurityoAuth2ClientCredentials
Request
path Parameters
cnpjOrCpf
required
integer <int32>
documentTypeId
required
integer <int32>
Request Body schema: multipart/form-data

Para envio de ficheiro deve ser feita uma requisição do tipo multipart/form-data com nome da propriedade sendo file. Tipos de ficheiro aceitavel(jpg, png, jpeg,pdf,doc,xls,docx,xlsx,odt,ods).

file
string <binary>
Responses
200

Return a document uploaded

400

Unable to return a document uploaded due to validation error

post/api/v1/clinics/{cnpjOrCpf}/documentTypes/{documentTypeId}/documents
Response samples
application/json
[
  • {
    }
]

Rota responsável pelo upload do documento de uma solicitação.

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
documentTypeId
required
integer <int32>
solicitationId
required
integer <int32>
Request Body schema: multipart/form-data

Para envio de ficheiro deve ser feita uma requisição do tipo multipart/form-data com nome da propriedade sendo file. Tipos de ficheiro aceitavel(jpg, png, jpeg,pdf,doc,xls,docx,xlsx,odt,ods).

file
string <binary>
Responses
200

Return a document uploaded

400

Unable to return a document uploaded due to validation error

post/api/v1/users/{userId}/solicitations/{solicitationId}/documentTypes/{documentTypeId}/documents
Response samples
application/json
[
  • {
    }
]

Rota responsável por devolver um documento para download

SecurityoAuth2ClientCredentials
Request
path Parameters
documentId
required
integer <int32>
Responses
200

Return a document for download

400

Unable to return a document with this id due to validation error

404

No document registered by this id in the system was found

get/api/v1/documents/{documentId}/download
Response samples
application/json
[
  • {
    }
]

Rota responsável por retornar uma lista de tipos de documentos. Você pode usar parâmetros de consulta para especificar os tipos que deseja

SecurityoAuth2ClientCredentials
Request
query Parameters
types
Array of integers or null <int32>
Responses
200

Return a list of documents types

400

Unable to return a list of documents types due to validation error

404

No documents types registered in the system was found

get/api/v1/documents/documents-types
Response samples
application/json
[
  • {
    }
]
➔ Next to OccupationData