Brein API

Address

Get all addresses with pagination

GET

/api/v1/address

Retrieve a paginated list of addresses based on query parameters

Get all addresses with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all addresses with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

Create a new address

POST

/api/v1/address

Create a new address with the provided data

Create a new address › Request Body

formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

Create a new address › Responses

Address created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

POST /api/v1/address

curl --request POST \
  --url /api/v1/address \
  --header 'Content-Type: application/json' \
  --data '
{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}
'

shell

Show example in

Request Body Example

{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}

json

Example Responses

No example

json

application/json

Get address by ID

GET

/api/v1/address/{id}

Retrieve a specific address by its ID

Get address by ID › path Parameters

idnumber · min: 1 · required
Id

Get address by ID › Responses

Address detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

GET /api/v1/address/{id}

curl --request GET \
  --url /api/v1/address/:id

shell

Show example in

Example Responses

No example

json

application/json

Update an address

PUT

/api/v1/address/{id}

Update an existing address by its ID

Update an address › path Parameters

idnumber · min: 1 · required
Id

Update an address › Request Body

formattedAddressstring
Street of the address
Example: Main St
zipCodestring
Postal code of the address
Example: 10001
citystring
City of the address
Example: New York
countrystring
Country of the address
Example: USA
placeIdstring
Place id maps
latitudenumber
Geo latitude
longitudenumber
Geo longitude

Update an address › Responses

Address updated

No data returned

PUT /api/v1/address/{id}

curl --request PUT \
  --url /api/v1/address/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}
'

shell

Show example in

Request Body Example

{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}

json

Example Responses

No example

plain

Delete an address

DELETE

/api/v1/address/{id}

Delete an address by its ID

Delete an address › path Parameters

idnumber · min: 1 · required
Id

Delete an address › Responses

Address deleted

No data returned

School Administrator Application Module

Brein API

Address

Get all addresses with pagination

GET

/api/v1/address

Retrieve a paginated list of addresses based on query parameters

Get all addresses with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all addresses with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

Create a new address

POST

/api/v1/address

Create a new address with the provided data

Create a new address › Request Body

formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

Create a new address › Responses

Address created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

POST /api/v1/address

curl --request POST \
  --url /api/v1/address \
  --header 'Content-Type: application/json' \
  --data '
{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}
'

shell

Show example in

Request Body Example

{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}

json

Example Responses

No example

json

application/json

Get address by ID

GET

/api/v1/address/{id}

Retrieve a specific address by its ID

Get address by ID › path Parameters

idnumber · min: 1 · required
Id

Get address by ID › Responses

Address detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
formattedAddressstring · required
Street of the address
Example: Main St
zipCodestring · required
Postal code of the address
Example: 10001
citystring · required
City of the address
Example: New York
countrystring · required
Country of the address
Example: USA
placeIdstring · required
Place id maps
latitudenumber · required
Geo latitude
longitudenumber · required
Geo longitude

GET /api/v1/address/{id}

curl --request GET \
  --url /api/v1/address/:id

shell

Show example in

Example Responses

No example

json

application/json

Update an address

PUT

/api/v1/address/{id}

Update an existing address by its ID

Update an address › path Parameters

idnumber · min: 1 · required
Id

Update an address › Request Body

formattedAddressstring
Street of the address
Example: Main St
zipCodestring
Postal code of the address
Example: 10001
citystring
City of the address
Example: New York
countrystring
Country of the address
Example: USA
placeIdstring
Place id maps
latitudenumber
Geo latitude
longitudenumber
Geo longitude

Update an address › Responses

Address updated

No data returned

PUT /api/v1/address/{id}

curl --request PUT \
  --url /api/v1/address/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}
'

shell

Show example in

Request Body Example

{
  "formattedAddress": "Main St",
  "zipCode": "10001",
  "city": "New York",
  "country": "USA",
  "placeId": "placeId",
  "latitude": 0,
  "longitude": 0
}

json

Example Responses

No example

plain

Delete an address

DELETE

/api/v1/address/{id}

Delete an address by its ID

Delete an address › path Parameters

idnumber · min: 1 · required
Id

Delete an address › Responses

Address deleted

No data returned

School Administrator Application Module