Powered by Redocly

Partners (1.0.0)

Download OpenAPI specification:Download

DrCash API for Partners

Address

Rota responsável por retornar uma lista de todos os endereços cadastrados no sistema

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

A list of all addresses registered in the system

400

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

404

No addresses registered in the system was found

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

Rota responsável por retornar uma lista de endereços para um usuário

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Responses
200

Return a list of addresses for a user

400

Unable to return a list of addresses by user id due to validation error

404

No address registered by this user id in the system was found

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

Rota responsável por adicionar um novo endereço de usuário

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Request Body schema:
country
required
string
state
required
string
city
required
string
neighborhood
required
string
street
required
string
number
required
string
zipCode
required
string
propertyTypeId
required
integer <int32>
complement
string or null
Responses
200

Add a new user address

400

Unable to add a new user's address due to validation error

post/api/v1/users/{userId}/addresses
Request samples
{
  • "country": "Brasil",
  • "state": "MG",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "zipCode": "12345-678",
  • "propertyTypeId": 1,
  • "complement": "ap 9"
}
Response samples
application/json
{
  • "id": 1,
  • "country": "Brasil",
  • "zipCode": "12345-678",
  • "state": "MG",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "complement": "ap 9",
  • "latitude": 0,
  • "longitude": 0,
  • "propertyType": {
    }
}

Rota responsável por devolver uma lista de endereços para um teste clínico

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

Return a list of addresses for a clinic

404

No address registered by this clinic id in the system was found

500

Internal server error

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

Rota responsável por adicionar um novo endereço de clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
Request Body schema:
country
required
string
state
required
string
city
required
string
neighborhood
required
string
street
required
string
number
required
string
zipCode
required
string
propertyTypeId
required
integer <int32>
complement
string or null
Responses
200

Add a new clinic address

400

Unable to add a new clinic's address due to validation error

post/api/v1/clinics/{clinicId}/addresses
Request samples
{
  • "country": "Brasil",
  • "state": "MG",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "zipCode": "12345-678",
  • "propertyTypeId": 1,
  • "complement": "ap 9"
}
Response samples
application/json
{
  • "id": 1,
  • "country": "Brasil",
  • "zipCode": "12345-678",
  • "state": "MG",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "complement": "ap 9",
  • "latitude": 0,
  • "longitude": 0,
  • "propertyType": {
    }
}

Rota responsável por devolver uma lista de endereços para um beneficiário

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

Return a list of addresses for a beneficiary id

400

Unable to return a list of addresses by beneficiary id due to validation error

404

No address registered by this beneficiary id in the system was found

get/api/v1/beneficiaries/{beneficiaryId}/addresses
Response samples
application/json
[
  • {
    }
]

Rota responsável por adicionar um novo endereço para um beneficiário

SecurityoAuth2ClientCredentials
Request
path Parameters
beneficiaryId
required
integer <int32>
Request Body schema:
country
required
string
state
required
string
city
required
string
neighborhood
required
string
street
required
string
number
required
string
zipCode
required
string
propertyTypeId
required
integer <int32>
complement
string or null
Responses
200

Add a new beneficiary address

400

Unable to add a new beneficiary's address due to validation error

post/api/v1/beneficiaries/{beneficiaryId}/addresses
Request samples
{
  • "country": "Brasil",
  • "state": "MG",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "zipCode": "12345-678",
  • "propertyTypeId": 1,
  • "complement": "ap 9"
}
Response samples
application/json
{
  • "id": 1,
  • "country": "Brasil",
  • "zipCode": "12345-678",
  • "state": "MG",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "complement": "ap 9",
  • "latitude": 0,
  • "longitude": 0,
  • "propertyType": {
    }
}

Rota responsável por devolver uma lista de endereços para um estado

SecurityoAuth2ClientCredentials
Responses
200

Success

400

Bad Request

get/api/v1/addresses/states-with-cities
Response samples
application/json
[
  • {
    }
]

Rota responsável por retornar uma lista de estados e total de clínicas

SecurityoAuth2ClientCredentials
Responses
200

Return a list of states and total clinics

400

Unable to return a list of states and total clinics due to validation error

404

No state registered in the system was found

get/api/v1/addresses/states-with-total-clinics
Response samples
application/json
[
  • {
    }
]

Rota responsável por atualizar um endereço

SecurityoAuth2ClientCredentials
Request
path Parameters
addressId
required
integer <int32>
Request Body schema:
state
required
string
country
required
string
city
required
string
neighborhood
required
string
street
required
string
number
required
string
zipCode
required
string
propertyTypeId
required
integer <int32>
complement
string or null
Responses
200

Update a beneficiary address

400

Unable to update a beneficiary's address due to validation error

put/api/v1/addresses/{addressId}
Request samples
{
  • "state": "MG",
  • "country": "Brasil",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "zipCode": "12345-678",
  • "propertyTypeId": 1,
  • "complement": "ap 9"
}
Response samples
application/json
{
  • "id": 1,
  • "country": "Brasil",
  • "zipCode": "12345-678",
  • "state": "MG",
  • "city": "Unaí",
  • "neighborhood": "Divineia",
  • "street": "Av. Governador valadares",
  • "number": "123",
  • "complement": "ap 9",
  • "latitude": 0,
  • "longitude": 0,
  • "propertyType": {
    }
}

Rota responsável por deletar um endereço

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

Delete a beneficiary address

400

Unable to delete a beneficiary's address due to validation error

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

Rota responsável por registrar um novo tipo de imóvel

SecurityoAuth2ClientCredentials
Request
Request Body schema:
type
required
string
Responses
200

Register a new property type

400

Unable to register a new property type due to validation error

post/api/v1/addresses/property-types
Request samples
{
  • "type": "Alugado"
}
Response samples
application/json
{
  • "id": 3,
  • "type": "Financiado"
}

Rota responsável por retornar uma lista de tipos de propriedade

SecurityoAuth2ClientCredentials
Responses
200

Return a list of property types

400

Unable to return a list property types due to validation error

get/api/v1/addresses/property-types
Response samples
application/json
[
  • {
    }
]