API is in Alpha and may change at any time.
API Resources > Civilian
Create Civilian
This endpoint allows you to create a civilian.
Create Civilian
POST api/v1/civilian/create_civilian
Request Body
Name | Type | Description | Default |
---|---|---|---|
user_id | number | User ID. | Required |
first_name | string | First name of civilian. | Required |
last_name | string | Last name of civilian. | Required |
date_of_birth | string/date | Date of birth. mm/dd/yyyy. | Required |
height | number | Height of civilian in inches. | Required |
weight | number | Weight of civilian in pounds (lb). | Required |
occupation | string | Occupation of Civilian. | "" |
gender | string | Gender of civilian. [Male, Female, Other] | Required |
race | string | Race of civilian. | Required |
postal | number | Postal Address of civilian. | Required |
street | string | Street of address. | Required |
city | string | City of address. | Required |
picture | string | Url to picture of civilian. | "" |
Example Request Body
{
"user_id": 123456789123456789,
"first_name": "John",
"last_name": "Doe II",
"date_of_birth": "09/17/1987",
"height": 72,
"weight": 250,
"occupation": "",
"gender": "Male",
"race": "White",
"postal": 1234,
"street": "Route 68",
"city": "Sandy Shores",
"picture": "",
}
Responses
200 A successful call.
{
"success": true,
"message": "",
"data": [
{
"id": 123456789,
"user_id": "123456789123456789",
"first_name": "John",
"last_name": "Doe II",
"full_name": "John Doe II",
"picture": null,
"date_of_birth": "09/07/1987",
"gender": "Male",
"race": "White",
"postal": "1234",
"street": "Test",
"city": "Test",
"full_address": "1234 Test Test",
"occupation": null,
"height": "73",
"weight": "250",
"status": null,
"status_name": null,
"active_persona": null,
"created_at": "05/05/2024 22:02:33",
"updated_at": "05/05/2024 22:02:33",
"is_violent": null,
"is_weapon": null,
"is_ill": null,
"is_swat": null,
"is_ciu": null,
"is_warrant": null
}
]
}
200 with validation errors.
200 with maxed out civilians.
{
"success": false,
"message": "You have reached your max civilians.",
"data": []
}
200 with same name already used.
{
"success": false,
"message": "That name is already in use. Choose a diffrent name..",
"data": []
}
Still have questions?
Still have questions? Talk to support.