User's Car

NOTE: Use the following endpoints only if you intend to store the personal information of your users on GIZO platform.

Adding a New Vehicle

The endpoint is designed to handle requests for adding the information associated with the user's vehicles.

post

Authorizations

AuthorizationstringRequired

Provide a JWT Bearer

Body

carModelIdinteger · int64Optional

licensestring · min: 1Required

yearOfProductioninteger · int32 · min: 1900 · max: 2099Required

mileageinteger · int32Required

Responses

200

Success

application/json

Responseboolean

post

/api/v2/User/carModel

POST /api/v2/User/carModel HTTP/1.1
Host: api.artificient.de
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "carModelId": 1,
  "license": "text",
  "yearOfProduction": 1,
  "mileage": 1
}

200

Success

true

Header Request Parameters

Authentication Bearer Token

Request Body Parameters

carModelName: the model name of the user's car that is expected to be a string value, e.g. "C200".

carBrandName: the brand name of the user's car that is expected to be a string value, e.g. "Benz".

license: the license plate number of the user's car that is expected to be a string value, e.g. "RAKL 8136".

yearOfProduction: the year of production of the user's car that is expected to be a numeric value, e.g. 2001.

NOTE: yearOfProduction must be added between 1900 and the current year.

mileage: the mileage or distance traveled by the user's car that is expected to be a numeric value, e.g. 1000.

NOTE: the maximum number of characters in mileage is 9.

Response

If it is true, it means that the car model is added.

Selecting the Current Vehicle

The endpoint is designed to handle requests for selecting the vehicle which is currently being driven by the user.

patch

/api/v1/User/carModel/select

Authorizations

AuthorizationstringRequired

Provide a JWT Bearer

Body

idinteger · int64Optional

Responses

200

Success

application/json

Responseboolean

patch

/api/v1/User/carModel/select

PATCH /api/v1/User/carModel/select HTTP/1.1
Host: api.artificient.de
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "id": 1
}

200

Success

true

Header Request Parameters

Authentication Bearer Token

Request Body Parameters

id: The ID of the car which is selected and is expected to be a numeric value, e.g. 1560

Response

If it is true, it means that the car model is selected.

Getting the List of All Vehicles of a User

The endpoint is designed to handle requests for retrieving the model of cars associated with the user.

get

Authorizations

AuthorizationstringRequired

Provide a JWT Bearer

Responses

200

Success

application/json

get

/api/v2/User/carModels

GET /api/v2/User/carModels HTTP/1.1
Host: api.artificient.de
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

[
  {
    "id": 1,
    "carModelId": 1,
    "carBrandId": 1,
    "carName": "text",
    "carModel": "text",
    "license": "text",
    "yearOfProduction": 1,
    "mileage": 1,
    "isSelected": true
  }
]

Header Request Parameters

Authentication Bearer Token

Response

The provided endpoint response contains an array of several properties, including:

id: this property represents the ID of the car. It is expected to be a numeric value, e.g. 2256.

carModelId: the carModelId property represents the ID of the car model associated with the car. It is expected to be a numeric value, e.g. 80.

caBrandId: this property represents the ID of the car brand associated with the car. It is expected to be a numeric value, e.g. 3.

carName: the carName property represents the name or identifier of the car. It is expected to be a string value, e.g. "Benz".

carModel: this property represents the model of the car. It is expected to be a string value, e.g. "C200".

license: the license property represents the license plate number or identifier of the car. It is expected to be a string value, e.g. "RAKL 8136".

yearOfProduction: this property represents the year of production for the car. It is expected to be a numeric value, e.g. 2023.

mileage: the mileage property represents the mileage or distance traveled by the car. It is expected to be a numeric value, e.g. 1000.

isSelected: the isSelected property is a Boolean value (true or false). This property typically indicates whether the car is selected or chosen for a particular purpose, e.g. false.

NOTE: just one car can be selected on a list.

Getting the Information about a Vehicle By ID

The endpoint is designed to handle requests for retrieving or fetching a specific car model associated with a user.

get

Authorizations

AuthorizationstringRequired

Provide a JWT Bearer

Path parameters

idinteger · int64Required

Responses

200

Success

application/json

get

/api/v2/User/carModels/{id}

GET /api/v2/User/carModels/{id} HTTP/1.1
Host: api.artificient.de
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "id": 1,
  "carModelId": 1,
  "carBrandId": 1,
  "carName": "text",
  "carModel": "text",
  "license": "text",
  "yearOfProduction": 1,
  "mileage": 1,
  "isSelected": true
}

Header Request Parameters

Authentication Bearer Token

Request Parameters

id: the ID of the car and which is expected to be a numeric value, e.g. 2256.

Response

The provided endpoint response contains several properties, including: