Powered by Redocly

PersonalData

Rota responsável por retornar uma lista de dados pessoais salvos no sistema

SecurityoAuth2ClientCredentials
Responses
200

A list of all personal data registered in the system

400

Unable to return a list of all personal data due to validation error

404

No personal data registered in the system was found

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

Rota responsável por devolver uma lista de dados pessoais por cliente

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Responses
200

A list of all personal data for a user registered in the system

400

Unable to return a list of all personal data for a user due to validation error

404

No personal data for this user id registered in the system was found

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

Rota responsável pelo registo dos dados pessoais de um cliente

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Request Body schema:
mothersName
required
string
rg
required
string
nationality
required
string
equityValue
required
string
gender
required
string
civilStatus
required
string
Responses
200

Add personal data for a user registered in the system

400

Unable to add a personal data for a user due to validation error

404

No user with this user id registered in the system was found

post/api/v1/users/{userId}/personalData
Request samples
{
  • "mothersName": "Francisca Maria Alves Cunha",
  • "rg": "2884394",
  • "nationality": "Brasileira",
  • "equityValue": "R$ 10.000,00",
  • "gender": "Feminino",
  • "civilStatus": "Casada"
}
Response samples
application/json
{
  • "id": 1,
  • "mothersName": "Francisca Maria Alves Cunha",
  • "rg": "1234567",
  • "nationality": "Brasileiro",
  • "equityValue": "R$ 10.000,00",
  • "gender": "Feminino",
  • "civilStatus": "Filho"
}

Rota responsável pela atualização dos dados pessoais por Id

SecurityoAuth2ClientCredentials
Request
path Parameters
personalDataId
required
integer <int32>
Request Body schema:
mothersName
required
string
rg
required
string
nationality
required
string
equityValue
required
string
gender
required
string
civilStatus
required
string
Responses
200

Update a personal data

400

Unable to update a personal data due to validation error

404

No personal data registered with this id in the system was found

put/api/v1/personalData/{personalDataId}
Request samples
{
  • "mothersName": "Francisca Maria Alves Cunha",
  • "rg": "2884394",
  • "nationality": "Brasileira",
  • "equityValue": "R$ 10.000,00",
  • "gender": "Feminino",
  • "civilStatus": "Casada"
}
Response samples
application/json
{
  • "id": 1,
  • "mothersName": "Francisca Maria Alves Cunha",
  • "rg": "1234567",
  • "nationality": "Brasileiro",
  • "equityValue": "R$ 10.000,00",
  • "gender": "Feminino",
  • "civilStatus": "Filho"
}

Rota responsável pela exclusão de dados pessoais por Id

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

Delete a personal data

204

Success

400

Unable to delete a personal data due to validation error

delete/api/v1/personalData/{personalDataId}
Response samples
application/json
{
  • "errors": [ ],
  • "httpStatus": 500
}
➔ Next to Solicitation