Documentation Powered by ReDoc

Documentação - Tupã Server (v1.0.0)

Download OpenAPI specification:Download

BaseTech Inc.: basetechincorporations@gmail.com URL: https://github.com/BaseTech-Inc

Documentação para o uso da API.

Authentication

Bearer

Enter JWT Bearer token only

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Account

/api/Account/login

Authorizations:
Bearer
query Parameters
email
string
password
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/Account/login-google

Authorizations:
Bearer
query Parameters
idToken
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/Account/register

Authorizations:
Bearer
query Parameters
username
string
email
string
password
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/Account/refresh-token

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/Account/revoke-token

Authorizations:
Bearer
query Parameters
token
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/Account/logout

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/Account/verify-email

Authorizations:
Bearer
query Parameters
userId
string
tokenEmail
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/Account/generate-password-reset

Authorizations:
Bearer
query Parameters
email
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/Account/change-password

Authorizations:
Bearer
query Parameters
email
string
token
string
password
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/Account/change-password/id

Authorizations:
Bearer
query Parameters
UserId
string
oldPassword
string
newPassword
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/Account/basic-profile

Authorizations:
Bearer
query Parameters
UserId
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/Account/basic-profile

Authorizations:
Bearer
query Parameters
UserId
string
UserName
string
TipoUsuario
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/Account

Authorizations:
Bearer
query Parameters
UserId
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

Alertas

/api/v1/Alertas

Authorizations:
Bearer
query Parameters
year
integer <int32>
month
integer <int32>
day
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Alertas

Authorizations:
Bearer
query Parameters
Latitude
number <double>
Longitude
number <double>
Distrito
string
Cidade
string
Estado
string
Pais
string
TempoInicio
string <date-time>
TempoFinal
string <date-time>
Descricao
string
Transitividade
boolean
Atividade
boolean

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/Alertas

Authorizations:
Bearer
query Parameters
Id
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/Alertas/Bairro

Authorizations:
Bearer
query Parameters
year
integer <int32>
month
integer <int32>
day
integer <int32>
district
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Alertas/Pagination

Authorizations:
Bearer
query Parameters
year
integer <int32>
month
integer <int32>
day
integer <int32>
PageNumber
integer <int32>
Default: 1
PageSize
integer <int32>
Default: 10

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

Cidades

/api/v1/Cidades

Authorizations:
Bearer
query Parameters
object (GetAllCidadeQuery)

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Cidades/name/{name}

Authorizations:
Bearer
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Cidades/id/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Cidades/pagination

Authorizations:
Bearer
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Cidades/meshes/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

Distritos

/api/v1/Distritos

Authorizations:
Bearer
query Parameters
object (GetAllDistritosQuery)

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Distritos/name/{name}

Authorizations:
Bearer
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Distritos/id/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Distritos/pagination

Authorizations:
Bearer
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

Estados

/api/v1/Estados

Authorizations:
Bearer
query Parameters
object (GetAllEstadosQuery)

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Estados/name/{name}

Authorizations:
Bearer
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Estados/id/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Estados/pagination

Authorizations:
Bearer
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Estados/meshes/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

Forecast

/api/v1/Forecast/coord

Authorizations:
Bearer
query Parameters
lat
number <float>
lon
number <float>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Forecast/name

Authorizations:
Bearer
query Parameters
street
string
district
string
city
string
state
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

GooglePoints

/api/v1/GooglePoints/encode-geojson

Authorizations:
Bearer
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
type
integer <int32> (GeoJSONObjectType)
Enum: 0 1 2 3 4 5 6 7 8
object (LineString)

Responses

Request samples

Content type
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "type": 0,
  • "geometry": {
    }
}

Response samples

Content type
application/json
application/json
text/json
"string"

/api/v1/GooglePoints/encode-coordinates

Authorizations:
Bearer
Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
Array ()
count
integer <int32>
id
string or null
latitude
number <double>
longitude
number <double>

Responses

Request samples

Content type
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
[
  • {
    }
]

Response samples

Content type
application/json
application/json
text/json
"string"

/api/v1/GooglePoints/decode-coordinates

Authorizations:
Bearer
query Parameters
encodedPoints
string

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

/api/v1/GooglePoints/decode-geojson

Authorizations:
Bearer
query Parameters
encodedPoints
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "type": 0,
  • "id": "string",
  • "geometry": {
    }
}

HistoricoUsuario

/api/v1/HistoricoUsuario

Authorizations:
Bearer
query Parameters
UserId
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/HistoricoUsuario

Authorizations:
Bearer
query Parameters
UserId
string
TempoChegada
string <date-time>
TempoPartida
string <date-time>
DistanciaPercurso
number <double>
Rota
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/HistoricoUsuario

Authorizations:
Bearer
query Parameters
Id
string
UserId
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/HistoricoUsuario/id

Authorizations:
Bearer
query Parameters
UserId
string
Id
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/HistoricoUsuario/date

Authorizations:
Bearer
query Parameters
UserId
string
date
string <date-time>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/HistoricoUsuario/pagination

Authorizations:
Bearer
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>
UserId
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

Localidades

/api/v1/Localidades

Authorizations:
Bearer
query Parameters
namePais
string
nameEstado
string
nameCidade
string
nameDistrito
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

Marcadores

/api/v1/Marcadores

Authorizations:
Bearer
query Parameters
UserId
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Marcadores

Authorizations:
Bearer
query Parameters
Latitude
number <double>
Longitude
number <double>
UserId
string
Nome
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/Marcadores

Authorizations:
Bearer
query Parameters
Id
string
UserId
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/Marcadores

Authorizations:
Bearer
query Parameters
Id
string
Latitude
number <double>
Longitude
number <double>
UserId
string
Nome
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/Marcadores/id

Authorizations:
Bearer
query Parameters
UserId
string
Id
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

Paises

/api/v1/Paises

Authorizations:
Bearer
query Parameters
object (GetAllPaisesQuery)

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Paises/name/{name}

Authorizations:
Bearer
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/Paises/id/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Paises/pagination

Authorizations:
Bearer
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/Paises/meshes/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

PontoRisco

/api/v1/PontoRisco

Authorizations:
Bearer
query Parameters
object (GetAllPontoRiscoQuery)

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}

/api/v1/PontoRisco

Authorizations:
Bearer
query Parameters
Descricao
string
Latitude
number <double>
Longitude
number <double>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/PontoRisco

Authorizations:
Bearer
query Parameters
Id
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/PontoRisco

Authorizations:
Bearer
query Parameters
Id
string
Descricao
string
Latitude
number <double>
Longitude
number <double>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": "string"
}

/api/v1/PontoRisco/id/{Id}

Authorizations:
Bearer
path Parameters
Id
required
string

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

/api/v1/PontoRisco/pagination

Authorizations:
Bearer
query Parameters
PageNumber
integer <int32>
PageSize
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": {
    }
}

Usuarios

/api/v1/Usuarios

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "succeeded": true,
  • "message": "string",
  • "errors": [
    ],
  • "data": [
    ]
}