Vehicle Endpoints
The API has been deprecated and is no longer in use.
Vehicle Endpoints
Raw list of vehicle endpoints:
GET /vehicle/plate
GET /vehicle/list
POST /vehicle/create
PATCH /vehicle/edit
DELETE /vehicle/delete
List of vehicle endpoint methods
If you see the empty "vehicle" array or vehicle: []
This is simply just the placeholder for the vehicle object structure, Which looks like this in all major requests: (Inside the array)
{
id: "ID",
userID: "USER_ID",
userName: "USER_NAME",
civilianID: "CIV_ID",
civilianName: "CIV_NAME",
impounded: "IMPOUNDED",
stolen: "STOLEN",
plate: "PLATE",
model: "MODEL",
registration: "REGISTRATION",
insurance: "INSURANCE",
color: "COLOR",
colorType: "COLOR_TYPE",
timestamp: "TIMESTAMP",
}
Vehicle Search
GET
https://roleplaybot.xyz/api/vehicle/plate
Searches a civilian plate and returns the information
Headers
Authorization*
API_KEY
API Authorization Key
Guild*
GUILD_ID
Discord Guild ID
Request Body
plate*
PLATE
Vehicle Plate (String)
Citations, Fine, Arrests and Hospital Record arrays provide an object per action.
{
found: true,
guildID: "GUILD_ID",
vehicle: []
}
List Vehicles
GET
https://roleplaybot.xyz/api/vehicle/list
Provides every registered vehicle inside the guild
Headers
Authorization*
API_KEY
API Authorization Key
Guild*
GUILD_ID
Discord Guild ID
Accessing a guild that is not authorized apart of your API key
{
"error": "403 Forbidden",
"details": "Unauthorised guild access (20058)"
}
Create Vehicle
POST
https://roleplaybot.xyz/api/vehicle/create
Registers a vehicle to a civilian character
Headers
Authorization*
API_KEY
API Authorization Key
Guild*
GUILD_ID
Discord Guild ID
Request Body
name*
CIV_NAME
Civilian Name (String)
plate*
PLATE
Vehicle Plate (String)
model*
MODEL
Vehicle Model (String)
color*
COLOR
Vehicle Color (String)
colorType*
COLOR_TYPE
Vehicle color type (Takes: Classic, Metallic, Matte, Metal, Pearlescent)
registration*
REGISTRATION
Vehicle registration (Takes: Valid, Expired)
insurance*
INSURANCE
Vehicle insurance (Takes: Valid, Expired, None)
Accessing a guild that is not authorized apart of your API key
{
"error": "403 Forbidden",
"details": "Unauthorised guild access (20058)"
}
Edit Vehicle
PATCH
https://roleplaybot.xyz/api/vehicle/edit
Edits a vehicle with the specified field and value Valid Fields: - color (Value: String) - insurance (Takes: Valid, Expired, None) - registration (Takes: Valid, Expired) - stole (Value: Boolean)
Headers
Authorization*
API_KEY
API Authorization Key
Guild*
GUILD_ID
Discord Guild ID
Request Body
name*
CIV_NAME
Civilian Name (String)
field*
FIELD
Field to edit (Must be listed in valid fields)
value*
VALUE
Value to set (Must match allocated field)
Accessing a guild that is not authorized apart of your API key
{
"error": "403 Forbidden",
"details": "Unauthorised guild access (20058)"
}
Delete Vehicle
DELETE
https://roleplaybot.xyz/api/vehicle/delete
Deletes a vehicle using the vehicle ID
Headers
Authorization*
API_KEY
API Authorization Key
Guild*
GUILD_ID
Discord Guild ID
Request Body
vehicleID*
VEHICLE_ID
Vehicle ID (String)
Successfully deleted vehicle
{
guildID: "GUILD_ID",
id: "VEHICLE_ID",
success: 'Deleted registered vehicle'
}
Last updated
Was this helpful?