Endpoints
Below is a table with each type of endpoint, with columns signifying the type of request, the endpoint address, a description of the endpoint, as well as the type of object it will return. If you would like to see the OpenAPI docs, you can find them here: https://peoplegeneratorapi.me/swagger-ui/index.html.
| Type of Request | Endpoint | Description | Return Type |
|---|---|---|---|
| GET | /api/person/ |
Returns a single person. | JSON Object |
| GET | /api/person/{NumberPeople} |
Returns a list of up to 50,000 people. Note that generating 50,000 people may take up to 7000ms before returning a response. | Array of JSON Objects |
| GET | /api/person/gender/ |
Returns the gender of a person, with the possible values being "Male", "Female", and "Other". | string |
| GET | /api/person/name/ |
Returns the name of a person. It is generally in the format "firstname lastname" but may also include no more than one middle name. | string |
| GET | /api/person/email/ |
Returns the email address of a person. There are a variety of formats and email providers this will pick from. | string |
| GET | /api/person/age/ |
Returns the age of a person. | integer |
| GET | /api/person/job/ |
Returns the job of a person. | string |
| GET | /api/person/dateofbirth/ |
Returns the date of birth of a person. | string |
| GET | /api/person/income/ |
Returns the income of a person in USD. | integer |
| GET | /api/person/creditscore/ |
Returns the credit score of a person. | integer |
| GET | /api/person/creditcardnumber/ |
Returns the credit card number of a person. Can be null depending on the person's age. | string |
| GET | /api/person/maritalstatus/ |
Returns the marital status of a person. | boolean |
| GET | /api/person/haschildren/ |
Returns whether a person has children or not. | boolean |
| GET | /api/person/height/ |
Returns the height of a person in centimeters. | integer |
| GET | /api/person/weight/ |
Returns the weight of a person in kilograms. | double |
| GET | /api/person/eyecolor/ |
Returns the eye color of a person. | string |
| GET | /api/person/hasdegree/ |
Returns whether a person has a degree. | boolean |
| GET | /api/person/gpa/ |
Returns a person's GPA on a 4.0 scale. | double |
| GET | /api/person/bloodtype/ |
Returns a person's blood type. | string |
| GET | /api/person/username/ |
Returns a person's generated username. | string |
| GET | /api/person/religion/ |
Returns a person's religion. | string |
| GET | /api/person/politicalleaning/ |
Returns a person's political leaning. | double |
| GET | /api/address/ |
Returns a random address object. See more information at fields. | Address Object |
| GET | /api/lifestory/ |
Returns a life story object containing the person's "life story". See more information at fields. | Life Story Object |