Powered by Redocly

Network

Rota responsável por devolver todas as redes de clínicas cadastradas com seus respectivos administradores

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

A list of all registered clinic networks registered in the system

400

Unable to return a list of all registered clinic networks due to validation error

404

No registered clinic networks registered in the system was found

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

Rota responsável por cadastrar uma nova rede de clínicas

SecurityoAuth2ClientCredentials
Request
Request Body schema:
name
required
string
Responses
200

Add a new network of clinics

400

Unable to add a new network of clinics due to validation error

post/api/v1/networks
Request samples
{
  • "name": "DENTISTA MAIS"
}
Response samples
application/json
{
  • "id": "12345bc5-cbad-49af-8095-c6b123e1234w",
  • "name": "Mendes Odontologia",
  • "totalClinics": 0,
  • "admin": null,
  • "advisor": null
}

Rota responsável por retornar uma rede por id

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

Return a network registered in the system

400

Unable to return a network due to validation error

404

No network registered with this id in the system was found

get/api/v1/networks/{networkId}
Response samples
application/json
{
  • "id": "12345bc5-cbad-49af-8095-c6b123e1234w",
  • "name": "Mendes Odontologia",
  • "totalClinics": 0,
  • "admin": null,
  • "advisor": null
}

Rota responsável por atualizar os dados de uma rede

SecurityoAuth2ClientCredentials
Request
path Parameters
networkId
required
integer <int32>
Request Body schema:
name
required
string
Responses
200

Update the data of a network in the system

400

Unable to update he data of a network due to validation error

put/api/v1/networks/{networkId}
Request samples
{
  • "name": "DENTISTA MAIS"
}
Response samples
application/json
{
  • "id": "12345bc5-cbad-49af-8095-c6b123e1234w",
  • "name": "Mendes Odontologia",
  • "totalClinics": 0,
  • "admin": null,
  • "advisor": null
}

Rota responsável por deletar uma rede

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

Delete a network

400

Unable to delete a network due to validation error

delete/api/v1/networks/{networkId}
Response samples
application/json
{
  • "errors": [ ],
  • "httpStatus": 500
}
➔ Next to OccupationData