Law Enforcement Endpoints

Law Enforcement Endpoints

Raw list of LEO endpoints:

  • GET /leo/records

  • GET /leo/impound

  • POST /leo/arrest

  • POST /leo/cite

  • POST /leo/fine

  • PATCH /leo/impound

List of Law enforcement endpoint methods

Civilian Records

GET https://roleplaybot.xyz/api/leo/records

Searches a civilians arrests, citations and fines

Headers

Name
Type
Description

Authorization*

API_KEY

API Authorization Key

Guild*

GUILD_ID

Discord Guild ID

Request Body

Name
Type
Description

name*

CIV_NAME

Civilian Name (String)

Civilian found and records listed

{
    guildID: "GUILD_ID",
    civilianName: "CIV_NAME",
    civilianID: "CIV_ID",
    citationAmount: "CITE_AMOUNT",
    fineAmount: "FINE_AMOUNT",
    arrestAmount: "ARREST_AMOUNT",
    citations: [
        {
            count: "COUNT",
            officersName: "OFFICER_NAME",
            officersID: "OFFICER_ID",
            amount: "AMOUNT",
            charges: "CHARGES",
            timestamp: "TIMESTAMP"
        }
    ],
    fines: [
        {
            count: "COUNT",
            officersName: "OFFICER_NAME",
            officersID: "OFFICER_ID",
            amount: "AMOUNT",
            charges: "CHARGES",
            timestamp: "TIMESTAMP"
        }
    ],
    arrests: [
        {
            count: "COUNT",
            officersName: "OFFICER_NAME",
            officersID: "OFFICER_ID",
            time: "JAIL_TIME",
            charges: "CHARGES",
            timestamp: "TIMESTAMP"
        }
    ]
}

Check Impound

GET https://roleplaybot.xyz/api/leo/impound

Checks if a vehicle is impounded

Headers

Name
Type
Description

Authorization*

API_KEY

API Authorization Key

Guild*

GUILD_ID

Discord Guild ID

Request Body

Name
Type
Description

plate

PLATE

Vehicle Plate (String)

Accessing a guild that is not authorized apart of your API key

{
    "error": "403 Forbidden",
    "details": "Unauthorised guild access (20058)"
}

Arrest Civilian

POST https://roleplaybot.xyz/api/leo/arrest

Forms an arrest report on a civilian

Headers

Name
Type
Description

Authorization*

API_KEY

API Authorization Key

Guild*

GUILD_ID

Discord Guild ID

Request Body

Name
Type
Description

name*

CIV_NAME

Civilian Name (String)

officerName*

OFFICER_NAME

Arresting Officers Discord Name (String)

officerID*

OFFICER_ID

Arresting Officers Discord ID (String)

charges*

CHARGES

Arrest Charges (String)

time*

TIME

Jail Time (Number) (>5000)

Accessing a guild that is not authorized apart of your API key

{
    "error": "403 Forbidden",
    "details": "Unauthorised guild access (20058)"
}

Cite Civilian

POST https://roleplaybot.xyz/api/leo/cite

Creates a citation and issues it to a civilian

Headers

Name
Type
Description

Authorization*

API_KEY

API Authorization Key

Guild*

GUILD_ID

Discord Guild ID

Request Body

Name
Type
Description

name*

CIV_NAME

Civilian Name (String)

officerName*

OFFICER_NAME

Citing Officers Discord Name (String)

officerID*

OFFICER_ID

Citing Officers Discord ID (String)

charges*

CHARGES

Citation Charges (String)

amount*

AMOUNT

Cite Amount (Number) (>5000)

Accessing a guild that is not authorized apart of your API key

{
    "error": "403 Forbidden",
    "details": "Unauthorised guild access (20058)"
}

Fine Civilian

POST https://roleplaybot.xyz/api/leo/fine

Fines a civilian

Headers

Name
Type
Description

Authorization*

API_KEY

API Authorization Key

Guild*

GUILD_ID

Discord Guild ID

Request Body

Name
Type
Description

name*

CIV_NAME

Civilian Name (String)

officerName*

OFFICER_NAME

Fining Officers Discord Name (String)

officerID*

OFFICER_ID

Fining Officers Discord ID (String)

charges*

CHARGES

Fine Charges (String)

amount*

AMOUNT

Fine Amount (Number) (>5000)

Accessing a guild that is not authorized apart of your API key

{
    "error": "403 Forbidden",
    "details": "Unauthorised guild access (20058)"
}

Impound Vehicle

PATCH https://roleplaybot.xyz/api/leo/impound

Impound or lift the impound of a registered vehicle

Headers

Name
Type
Description

Authorization*

API_KEY

API Authorization Key

Guild*

GUILD_ID

Discord Guild ID

Request Body

Name
Type
Description

plate*

PLATE

Vehicle Plate (String)

impound*

IMPOUND

Impound Stated Vehicle (Boolean)

fee

FEE

Impound Fee (Number) (>5000) (Only if impound statement true)

Accessing a guild that is not authorized apart of your API key

{
    "error": "403 Forbidden",
    "details": "Unauthorised guild access (20058)"
}

Last updated

Was this helpful?