Skip to content

Latest commit

 

History

History
129 lines (117 loc) · 2.22 KB

README.md

File metadata and controls

129 lines (117 loc) · 2.22 KB
Raw

EndPoints

POST /person

cria nova pessoa.

  • por padrão, as pessoas não são cadastradas com logradouros;
  • body:
{
    "name": "pedro",
    "dateOfBirth": "1998-09-27"
}

PUT /person/:id

  • :id = id da pessoa.

Atualiza registro da uma pessoa indicada pelo id.

  • body:
{
    "name": "pedro",
    "dateOfBirth": "1998-09-27"
}

GET /person/:id

  • :id = id da pessoa.

Busca pessoa por id.

{
    "id": 2,
    "name": "samuca",
    "dateOfBirth": "2002-01-22",
    "publicPlaces": [
        {
            "id": 1,
            "publicPlace": "Rua z",
            "cep": "12347890",
            "number": "46",
            "city": "jequie",
            "main": true
        }
    ]
}

GET /person

Lista todas as pessoas.

[
    {
        "id": 1,
        "name": "ana",
        "dateOfBirth": "2022-01-22",
        "publicPlaces": []
    },
    {
        "id": 2,
        "name": "pedro",
        "dateOfBirth": "1998-09-27",
        "publicPlaces": []
    }
]

POST /publicPlace/:id

  • :id = id da pessoa.

cria endereço (publicPlace) para pessoa indicada pelo id.

  • por padrão, o primeiro logradouro criado para uma pessoa, sera o seu endereço principal atual, você pode alterar isso usando o PUT /publicPlace/main/:id, listado logo abaixo.
  • o logradouro principal da pessoa é representado pelo campo "main"
  • body:
{
    "publicPlace": "Rua z",
    "cep": "12347890",
    "number": "46",
    "city":"ilheus"
}

GET /person/publicPlaces/:id

  • :id = id da pessoa.

Lista todos os endereços de uma pessoa.

[
    {
        "id": 1,
        "publicPlace": "Rua A",
        "cep": "12347890",
        "number": "19",
        "city": "Salvador",
        "main": true
    },
    {
        "id": 2,
        "publicPlace": "Rua z",
        "cep": "12347809",
        "number": "46",
        "city": "jequie",
        "main": false
    },

GET /publicPlace/main/:id

  • :id = id da pessoa.

Lista o logradouro principal da pessoa.

{
    "id": 1,
    "publicPlace": "Rua z",
    "cep": "12347890",
    "number": "46",
    "city": "jequie",
    "main": true
}

PUT /publicPlace/main/:id

  • :id = id da pessoa.

Atualiza o logradouro principal da pessoa.

  • body:
{
    "id": 2
}