Powered by Redocly

Clinic

Rota responsável por devolver uma lista de todas as clínicas cadastradas no sistema

SecurityoAuth2ClientCredentials
Request
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
clinicCode
string or null
tradingName
string or null
networkId
integer or null <int32>
clinicTypeId
integer or null <int32>
productionCodeId
integer or null <int32>
city
string or null
state
string or null
advisorId
string or null
clinicFlagId
integer or null <int32>
clinicStatusTypeId
integer or null <int32>
newsClinic
boolean or null
Responses
200

A list of all clinics registered in the system

400

Unable to return a list of all clinics due to validation error

404

No clinics registered in the system was found

get/api/v1/clinics
Response samples
application/json
[
  • {
    }
]

Rota responsável por devolver os dados de uma clinica cadastradas no sistema

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

Success

400

Bad Request

404

Not Found

get/api/v1/clinics/{clinicId}
Response samples
application/json
{
  • "id": 1,
  • "tradingName": "Dentista Mais",
  • "companyName": "Dentista Mais",
  • "cpfCnpj": "123.456.789-01",
  • "email": "dentista@email.com",
  • "financeEmail": null,
  • "code": "DR15",
  • "phoneNumber": "(61) 3827-2938",
  • "cellPhoneNumber": null,
  • "monthlyPayment": 0,
  • "isPrivacyPolicyAccepted": false,
  • "operatingFee": null,
  • "isActive": false,
  • "createdAt": "0001-01-01T00:00:00",
  • "network": {
    },
  • "address": {
    },
  • "bankData": {
    },
  • "clinicType": {
    },
  • "clinicFlag": null,
  • "clinicTier": null
}

Rota responsável pela atualização de uma clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
Request Body schema:
tradingName
required
string
companyName
required
string
cpfCnpj
required
string
email
required
string
financeEmail
required
string
code
required
string
phoneNumber
required
string
cellPhoneNumber
string or null
monthlyPayment
number <double>
clinicTypeId
required
integer <int32>
networkId
required
integer <int32>
clinicFlagId
required
integer <int32>
clinicTierId
required
integer <int32>
operatingFee
required
string
Responses
200

update a clinic

400

Unable to update a clinic due to validation error

404

No clinic registered with this id in the system was found

put/api/v1/clinics/{clinicId}
Request samples
{
  • "tradingName": "Clinica Mais",
  • "companyName": "Clinica Mais",
  • "cpfCnpj": "12.345.678/0001-22",
  • "email": "clinica@email.com",
  • "financeEmail": null,
  • "code": null,
  • "phoneNumber": "(61) 3456-2341",
  • "cellPhoneNumber": null,
  • "monthlyPayment": 0,
  • "clinicTypeId": 2,
  • "networkId": 0,
  • "clinicFlagId": 0,
  • "clinicTierId": 0,
  • "operatingFee": null
}
Response samples
application/json
{
  • "id": 1,
  • "tradingName": "Dentista Mais",
  • "companyName": "Dentista Mais",
  • "cnpj": "12.932.545/0001-15",
  • "email": "dentista@email.com",
  • "financeEmail": null,
  • "code": "DR15",
  • "phoneNumber": "(61) 3827-2938",
  • "operatingFee": 0
}

Rota responsável por excluir uma clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
Responses
204

delete a clinic

400

Unable to delete a clinic due to validation error

delete/api/v1/clinics/{clinicId}
Response samples
application/json
{
  • "errors": [ ],
  • "httpStatus": 500
}

Rota responsável por ativar ou desativar uma clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
Request Body schema:
isActive
required
boolean
Responses
200

Active or deactivate a clinic

400

Unable to active or deactivate a clinic due to validation error

patch/api/v1/clinics/{clinicId}
Request samples
{
  • "isActive": true
}
Response samples
application/json
{
  • "errors": [ ],
  • "httpStatus": 500
}

Rota responsável por retornar a lista de clínicas associadas a um usuário, Usada para retornar à clínica de um gerente/funcionário ou retornar uma lista de clínicas caso um gerente gerencie mais de uma.

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
clinicCode
string or null
tradingName
string or null
networkId
integer or null <int32>
clinicTypeId
integer or null <int32>
productionCodeId
integer or null <int32>
city
string or null
state
string or null
advisorId
string or null
clinicFlagId
integer or null <int32>
Responses
200

A list of all clinics associated with a user registered in the system

400

Unable to return a list of all clinics associated with a user due to validation error

404

No clinics registered associated with this user in the system was found

get/api/v1/users/{userId}/clinics
Response samples
application/json
[
  • {
    }
]

Rota responsável por devolver a lista de clínicas de uma rede

SecurityoAuth2ClientCredentials
Request
path Parameters
networkId
required
integer <int32>
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
clinicCode
string or null
tradingName
string or null
networkId
integer or null <int32>
clinicTypeId
integer or null <int32>
productionCodeId
integer or null <int32>
city
string or null
state
string or null
advisorId
string or null
clinicFlagId
integer or null <int32>
Responses
200

A list of all clinics associated with a network registered in the system

400

Unable to return a list of all clinics associated with a network due to validation error

404

No clinics registered associated with this network in the system was found

get/api/v1/networks/{networkId}/clinics
Response samples
application/json
[
  • {
    }
]

Rota responsável por cadastrar uma nova clínica em uma rede

SecurityoAuth2ClientCredentials
Request
path Parameters
networkId
required
integer <int32>
Request Body schema:
tradingName
required
string
companyName
required
string
cpfCnpj
required
string
email
required
string
financeEmail
required
string
phoneNumber
required
string
cellPhoneNumber
string or null
monthlyPayment
required
number <double>
clinicTypeId
required
integer <int32>
clinicTierId
required
integer <int32>
operatingFee
required
string
required
object (CreateAddressRequest)
required
object (CreateBankDataRequest)
Responses
200

Add a new clinic

400

Unable to add a clinic due to validation error

404

No network registered with this id in the system was found

post/api/v1/networks/{networkId}/clinics
Request samples
{
  • "tradingName": "Ortopedia Mais",
  • "companyName": "Ortopedia Mais",
  • "cpfCnpj": "12.456.378/0001-22",
  • "email": "dentista@email.com",
  • "financeEmail": "dentista@financeiro.com",
  • "phoneNumber": "(61) 3271-2847",
  • "cellPhoneNumber": "(61) 9 8164-2847",
  • "monthlyPayment": 100,
  • "clinicTypeId": 1,
  • "clinicTierId": 1,
  • "operatingFee": "3,9 %",
  • "address": {
    },
  • "bankData": {
    }
}
Response samples
application/json
{
  • "id": 1,
  • "tradingName": "Dentista Mais",
  • "companyName": "Dentista Mais",
  • "cpfCnpj": "123.456.789-01",
  • "email": "dentista@email.com",
  • "financeEmail": null,
  • "code": "DR15",
  • "phoneNumber": "(61) 3827-2938",
  • "cellPhoneNumber": null,
  • "monthlyPayment": 0,
  • "isPrivacyPolicyAccepted": false,
  • "operatingFee": null,
  • "isActive": false,
  • "createdAt": "0001-01-01T00:00:00",
  • "network": {
    },
  • "address": {
    },
  • "bankData": {
    },
  • "clinicType": {
    },
  • "clinicFlag": null,
  • "clinicTier": null
}

Rota responsável por devolver uma lista dos funcionários das clínicas

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
Responses
200

A list of all employees associated with a clinic registered in the system

400

Unable to return a list of all employees associated with a clinic due to validation error

404

No employee registered associated with this clinic in the system was found

get/api/v1/clinics/{clinicId}/employees
Response samples
application/json
[
  • {
    }
]

Rota responsável por devolver uma lista dos parceiros das clínicas

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
Responses
200

Success

400

Bad Request

404

Not Found

get/api/v1/clinics/{clinicId}/business-partners
Response samples
application/json
[
  • "string"
]

Rota responsável por devolver uma clínica por Id sem estar autenticada

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

A clinic registered in the system

400

Unable to return a clinic due to validation error

404

No clinic registered with this id in the system was found

get/api/v1/clinics/{clinicId}/public
Response samples
application/json
{
  • "id": 0,
  • "tradingName": "string",
  • "city": "string",
  • "state": "string",
  • "clinicTypeId": 0,
  • "clinicType": "string",
  • "isActive": true
}

Rota responsável por cadastrar um usuário com o perfil de Administrador da Clínica

SecurityoAuth2ClientCredentials
Request
Request Body schema:
email
required
string <email>
password
required
string <password>
confirmPassword
required
string <password>
name
required
string
cpf
required
string
birthdate
required
string
phoneNumber
required
string
networkId
required
integer <int32>
Responses
200

Return a new user with the profile of admin

400

Unable to return a new user with the profile of admin due to validation error

post/api/v1/clinics/register/network-admins
Request samples
{
  • "email": "sabrina@email.com",
  • "password": "********",
  • "confirmPassword": "********",
  • "name": "Sabrina Alves Cunha Veras",
  • "cpf": "123.456.789-01",
  • "birthdate": "03/03/1996",
  • "phoneNumber": "(61) 98245-8372",
  • "networkId": 1
}
Response samples
application/json
{
  • "userId": "string",
  • "token": "string",
  • "refreshToken": "string",
  • "expiresIn": 0,
  • "success": true,
  • "errors": [
    ],
  • "errorStatus": 0
}

Rota responsável por cadastrar um usuário com o perfil de Clinic Manager

SecurityoAuth2ClientCredentials
Request
Request Body schema:
email
required
string <email>
password
required
string <password>
confirmPassword
required
string <password>
name
required
string
cpf
required
string
birthdate
required
string
phoneNumber
required
string
clinicId
required
integer <int32>
Responses
200

Return a new user with the profile of admin

400

Unable to return a new user with the profile of admin due to validation error

post/api/v1/clinics/register/clinic-manager
Request samples
{
  • "email": "arthur@gmail.com",
  • "password": "********",
  • "confirmPassword": "********",
  • "name": "Arthur Pereira Borges",
  • "cpf": "039.384.294-83",
  • "birthdate": "02/05/1990",
  • "phoneNumber": "(61) 98473-2948",
  • "clinicId": 1
}
Response samples
application/json
{
  • "userId": "string",
  • "token": "string",
  • "refreshToken": "string",
  • "expiresIn": 0,
  • "success": true,
  • "errors": [
    ],
  • "errorStatus": 0
}

Rota responsável por cadastrar um usuário com o perfil de Funcionário da Clínica

SecurityoAuth2ClientCredentials
Request
Request Body schema:
email
required
string <email>
password
required
string <password>
confirmPassword
required
string <password>
name
required
string
cpf
required
string
birthdate
required
string
phoneNumber
required
string
clinicId
required
integer <int32>
Responses
200

Return a new user with the profile of admin

400

Unable to return a new user with the profile of admin due to validation error

post/api/v1/clinics/register/clinic-employees
Request samples
{
  • "email": "fernando@gmail.com",
  • "password": "********",
  • "confirmPassword": "********",
  • "name": "Fernando Henrique Alves Amaral",
  • "cpf": "052.704.041-09",
  • "birthdate": "03/03/1996",
  • "phoneNumber": "(61) 98245-8372",
  • "clinicId": 1
}
Response samples
application/json
{
  • "userId": "string",
  • "token": "string",
  • "refreshToken": "string",
  • "expiresIn": 0,
  • "success": true,
  • "errors": [
    ],
  • "errorStatus": 0
}

Rota responsável por cadastrar um usuário com o perfil de Clinic Partner

SecurityoAuth2ClientCredentials
Request
Request Body schema:
email
required
string <email>
password
required
string <password>
confirmPassword
required
string <password>
name
required
string
cpf
required
string
birthdate
required
string
phoneNumber
required
string
clinicId
required
integer <int32>
Responses
200

Return a new user with the profile of admin

400

Unable to return a new user with the profile of admin due to validation error

post/api/v1/clinics/register/clinic-partner
Request samples
{
  • "email": "fernando@gmail.com",
  • "password": "********",
  • "confirmPassword": "********",
  • "name": "Fernando Henrique Alves Amaral",
  • "cpf": "052.704.041-09",
  • "birthdate": "03/03/1996",
  • "phoneNumber": "(61) 98245-8372",
  • "clinicId": 1
}
Response samples
application/json
{
  • "userId": "string",
  • "token": "string",
  • "refreshToken": "string",
  • "expiresIn": 0,
  • "success": true,
  • "errors": [
    ],
  • "errorStatus": 0
}
➔ Next to Document