OccupationData

Rota responsável por devolver uma lista de todos os dados profissionais

SecurityoAuth2ClientCredentials
Responses
200

A list of all occupational data registered in the system

400

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

404

No occupational data registered in the system was found

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

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

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Responses
200

Uma lista de todos os dados ocupacionais por cliente cadastrados no sistema

400

Unable to return a list of all occupational data per client due to validation error

404

No client registered with this id in the system was found

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

Rota responsável pelo registo dos dados profissionais de um utilizador

SecurityoAuth2ClientCredentials
Request
path Parameters
userId
required
string or null
Request Body schema:
occupation
required
string
profession
required
string
employmentTime
required
string
companyCNPJ
string or null
companyZipCode
string or null
Responses
200

Add a new user's occupational data registered in the system

400

Unable to add a new user's occupational data due to validation error

post/api/v1/users/{userId}/occupationData
Request samples
{
  • "occupation": "Autônomo",
  • "profession": "Manicure",
  • "employmentTime": "5 anos",
  • "companyCNPJ": "87.542.342/0001-12",
  • "companyZipCode": "06712089"
}
Response samples
application/json
{
  • "id": 1,
  • "occupation": "Autônomo",
  • "profession": "Manicure",
  • "employmentTime": "5 anos",
  • "companyCNPJ": "87.542.342/0001-12",
  • "companyZipCode": "06712089"
}

Rota responsável pela atualização dos dados ocupacionais

SecurityoAuth2ClientCredentials
Request
path Parameters
occupationDataId
required
integer <int32>
Request Body schema:
occupation
required
string
profession
required
string
employmentTime
required
string
companyCNPJ
string or null
companyZipCode
string or null
Responses
200

Atualizar dados ocupacionais

400

Não foi possível atualizar os dados ocupacionais devido a um erro de validação

404

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

put/api/v1/occupationData/{occupationDataId}
Request samples
{
  • "occupation": "Autônomo",
  • "profession": "Manicure",
  • "employmentTime": "5 anos",
  • "companyCNPJ": "87.542.342/0001-12",
  • "companyZipCode": "06712089"
}
Response samples
application/json
{
  • "id": 1,
  • "occupation": "Autônomo",
  • "profession": "Manicure",
  • "employmentTime": "5 anos",
  • "companyCNPJ": "87.542.342/0001-12",
  • "companyZipCode": "06712089"
}

Rota responsável pela exclusão de dados profissionais

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

Delete a occupational data

400

Unable to delete a occupational data due to validation error

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