Civilian Endpoints

The API has been deprecated and is no longer in use.

Civilian Endpoints

Raw list of civilian endpoints:

• GET /civilian/info

• GET /civilian/list

• POST /civilian/create

• PATCH /civilian/edit

• PATCH /civilian/bolo

• PATCH /civilian/deceased

• DELETE /civilian/delete

List of civilian endpoint methods

Civilian Array Structure

If you see the empty "civilian" array or civilian: [] This is simply just the placeholder for the civilian object structure, Which looks like this in all major requests: (Inside the array)

{            
   deceased: "DECEASED",
   bolo: "BOLO",
   boloReason: "REASON",
   civilianAge: "AGE",
   civilianDOB: "DOB",
   civilianGender: "GENDER",
   civilianHairColor: "HAIR COLOR",
   civilianHeight: "HEIGHT",
   civilianWeight: "WEIGHT",
   civilianAddress: "ADDRESS",
   civilianOccupation: "OCCUPATION",
   registrationTimestamp: "TIMESTAMP",
}

Civilian Information

GET https://roleplaybot.xyz/api/civilian/info

Returns a civilians information

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 Characters Name (String)

200: OK Civilian Found

Citations, Fine, Arrests and Hospital Record arrays provide an object per action.

{
    "guildID": "GUILD_ID",
    "userID": "USER_ID",
    "userName": "USER_NAME",
    "civilian": [],
    "citations": [
        {
            "officerName": "OFFICER_NAME",
            "officerID": "OFFICER_ID",
            "amount": "AMOUNT",
            "charges": "CHARGES",
            "timestamp": "TIMESTAMP"
        }
    ],
    "fines": [
        {
            "officerName": "OFFICER_NAME",
            "officerID": "OFFICER_ID",
            "amount": "AMOUNT",
            "charges": "CHARGES",
            "timestamp": "TIMESTAMP"
        }
    ],
    "arrests": [
        {
            "officerName": "OFFICER_NAME",
            "officerID": "OFFICER_ID",
            "time": "TIME",
            "charges": "CHARGES",
            "timestamp": "TIMESTAMP"
        }
    ],
    "hospitalRecords": [
        {
            "medicName": "MEDIC_NAME",
            "medicID": "MEDIC_ID",
            "injures": "INJURES",
            "time": "TIME",
            "timestamp": "TIMESTAMP"
        }
    ]
}

400: Bad Request One or more fields are invalid

403: Forbidden Forbidden Guild Access

404: Not Found Civilian Not found

List Civilians

GET https://roleplaybot.xyz/api/civilian/list

Provides an array with objects per active civilian characters, also returns a value specifying the current amount of civilians

Headers

Name	Type	Description
Authorization*	API_KEY	API Authorization Key
Guild*	GUILD_ID	Discord Guild ID

403: Forbidden Forbidden Guild Access

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

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

200: OK Civilians Found

404: Not Found No Civilians Found

Create Civilian

POST https://roleplaybot.xyz/api/civilian/create

Creates a civilian character with supplied parameters

Headers

Name	Type	Description
Authorization*	API_KEY	API Authorization Key
Guild*	GUILD_ID	Discord Guild ID

Request Body

Name	Type	Description
userID*	USER_ID	Creating Users ID (String)
userName*	USER_NAME	Creating Users Name (String)
name*	CIV_NAME	Civilian Name (String) (<100 Characters)
age*	CIV_AGE	Civilian Age (Number) (<100)
dob*	CIV_DOB	Civilian Date Of Birth (String)
gender*	CIV_GENDER	Civilian Gender (Takes: Male, Female Or Other)
hair*	CIV_HAIR	Civilian Hair Color (String)
weight*	CIV_WEIGHT	Civilian Weight in KG (Number) (<500)
height*	CIV_HEIGHT	Civilian Height in CM (Number) (<500)
address*	CIV_ADDRESS	Civilian Address (String)
occupation*	CIV_OCCUPATION	Civilian Occupation (String)

403: Forbidden Forbidden Guild Access

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

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

400: Bad Request One or more fields are invalid

400: Bad Request Civilian name already exists

201: Created Created civilian

500: Internal Server Error Unable to register civilian

Edit Civilian

PATCH https://roleplaybot.xyz/api/civilian/edit

Edits a civilian character with the specified field and value Valid Fields: - hair color (Value: String) - name (Value: String) - age (Value: Number <100) - dob (Value: String) - height (Value: Number <500) - weight (Value: Number <500) - occupation (Value: String) - address (Value: String)

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)
field*	FIELD	Field to edit (Must be listed in valid fields)
value*	VALUE	Value to set (Must match allocated field)

403: Forbidden Forbidden Guild Access

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

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

400: Bad Request One or more fields are invalid

202: Accepted Value doesn't differ

201: Created Civilian Edited

500: Internal Server Error Unable to edit civilian

Civilian BOLO

PATCH https://roleplaybot.xyz/api/civilian/bolo

Call to activate or deactivate a BOLO

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)
bolo*	BOLO	Set BOLO (Boolean) (*True = Activate BOLO)
reason	REASON	BOLO Reason (Required when bolo is set to true)

403: Forbidden Forbidden Guild Access

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

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

404: Not Found Civilian Not Found

202: Accepted BOLO Already Active/inactive

201: Created BOLO Set Active/inactive

400: Bad Request One or more fields are missing/incorrect

Civilian Deceased

PATCH https://roleplaybot.xyz/api/civilian/deceased

Sets a civilian deceased. WARNING: This action is irreversible, Once a civilian is set deceased it can no longer be used.

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)
deceased*	DECEASED	Deceased Value (True Boolean) (True = Set Deceased)

202: Accepted Civilian Already Deceased

{
    guildID: "GUILD",
    civilianName: "CIV_NAME",
    civilianID: "CIV_ID",
    userName: "USER_NAME",
    userID: "USER_ID",
    deceased: "DECEASED",
    error: 'Character is already marked deceased'
}

400: Bad Request One or more fields are invalid

403: Forbidden Forbidden Guild Access

201: Created Civilian Marked Deceased

Delete Civilian

DELETE https://roleplaybot.xyz/api/civilian/delete

Deletes a civilian character

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)

200: OK Civilian Deleted

Successfully deleted civilian

{
    guildID: "GUILD_ID",
    civilianID: "CIV_ID",
    civilianName: "CIV_NAME",
    userName: "USER_NAME",
    userID: "USER_ID",
    success: "Deleted civilian",
    civilian: []
}

400: Bad Request One or more fields are invalid

500: Internal Server Error Unable to delete civilian