GET api/People?EmailAddress={EmailAddress}&APIKey={APIKey}&Count={Count}&StateSelection={StateSelection}

This API will generate a list of random fictional people intended to be used as test data for test automation, but any other non-nefarious use would be fine with us.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
EmailAddress

Client's email address given when they requested an API Key.

 string

Required
APIKey

Client's API Key check your email for this after your request of an API Key.

 string

Required
Count

Range 1 to 256

 integer

Default value is 1
StateSelection

Records from a particular state or any state in the United States.

 StateIDEnum

Default value is Any

Body Parameters

None.

Response Information

Resource Description

This API returns apiResponsePeople which includes state information about the call and if successful a collection of people records. See the apiResponsePeople definition below.

apiResponsePeople
NameDescriptionTypeAdditional information
responseStatus

The status of PeopleGeneratorAPI GET api/Passwords call.

 PeopleResponseEnum

None.
peopleList

People list containing the people generated if status == Success.

 Collection of spGetCompletePeopleRecords

None.
allTimeNumberOfCallsToThisAPI

The all time number of calls made by this client to the PasswordGeneratorAPI. (Will always return 1 for failed calls to the API.)

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "responseStatus": 0,
  "peopleList": [
    {
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "Prefix": "sample string 4",
      "Suffix": "sample string 5",
      "BirthDate": "2024-12-23T13:29:01.1441241-06:00",
      "Gender": "sample string 7",
      "SocialSecurityNumber": "sample string 8",
      "MaidenName": "sample string 9",
      "Alias": "sample string 10",
      "AddressLine1": "sample string 11",
      "AddressLine2": "sample string 12",
      "City": "sample string 13",
      "StateID": "sample string 14",
      "ZipCode": "sample string 15",
      "Zip4Code": "sample string 16",
      "CountyName": "sample string 17",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "PhoneNumber": "sample string 18",
      "Extension": "sample string 19"
    },
    {
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "Prefix": "sample string 4",
      "Suffix": "sample string 5",
      "BirthDate": "2024-12-23T13:29:01.1441241-06:00",
      "Gender": "sample string 7",
      "SocialSecurityNumber": "sample string 8",
      "MaidenName": "sample string 9",
      "Alias": "sample string 10",
      "AddressLine1": "sample string 11",
      "AddressLine2": "sample string 12",
      "City": "sample string 13",
      "StateID": "sample string 14",
      "ZipCode": "sample string 15",
      "Zip4Code": "sample string 16",
      "CountyName": "sample string 17",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "PhoneNumber": "sample string 18",
      "Extension": "sample string 19"
    }
  ],
  "allTimeNumberOfCallsToThisAPI": 1
}

application/xml, text/xml

Sample: 
<apiResponsePeople xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PasswordGeneratorAPI.Controllers">
  <allTimeNumberOfCallsToThisAPI>1</allTimeNumberOfCallsToThisAPI>
  <peopleList xmlns:d2p1="http://schemas.datacontract.org/2004/07/PasswordGeneratorAPI.Models">
    <d2p1:spGetCompletePeopleRecords>
      <d2p1:AddressLine1>sample string 11</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 12</d2p1:AddressLine2>
      <d2p1:Alias>sample string 10</d2p1:Alias>
      <d2p1:BirthDate>2024-12-23T13:29:01.1441241-06:00</d2p1:BirthDate>
      <d2p1:City>sample string 13</d2p1:City>
      <d2p1:CountyName>sample string 17</d2p1:CountyName>
      <d2p1:Extension>sample string 19</d2p1:Extension>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:Gender>sample string 7</d2p1:Gender>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Latitude>1</d2p1:Latitude>
      <d2p1:Longitude>1</d2p1:Longitude>
      <d2p1:MaidenName>sample string 9</d2p1:MaidenName>
      <d2p1:MiddleName>sample string 2</d2p1:MiddleName>
      <d2p1:PhoneNumber>sample string 18</d2p1:PhoneNumber>
      <d2p1:Prefix>sample string 4</d2p1:Prefix>
      <d2p1:SocialSecurityNumber>sample string 8</d2p1:SocialSecurityNumber>
      <d2p1:StateID>sample string 14</d2p1:StateID>
      <d2p1:Suffix>sample string 5</d2p1:Suffix>
      <d2p1:Zip4Code>sample string 16</d2p1:Zip4Code>
      <d2p1:ZipCode>sample string 15</d2p1:ZipCode>
    </d2p1:spGetCompletePeopleRecords>
    <d2p1:spGetCompletePeopleRecords>
      <d2p1:AddressLine1>sample string 11</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 12</d2p1:AddressLine2>
      <d2p1:Alias>sample string 10</d2p1:Alias>
      <d2p1:BirthDate>2024-12-23T13:29:01.1441241-06:00</d2p1:BirthDate>
      <d2p1:City>sample string 13</d2p1:City>
      <d2p1:CountyName>sample string 17</d2p1:CountyName>
      <d2p1:Extension>sample string 19</d2p1:Extension>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:Gender>sample string 7</d2p1:Gender>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Latitude>1</d2p1:Latitude>
      <d2p1:Longitude>1</d2p1:Longitude>
      <d2p1:MaidenName>sample string 9</d2p1:MaidenName>
      <d2p1:MiddleName>sample string 2</d2p1:MiddleName>
      <d2p1:PhoneNumber>sample string 18</d2p1:PhoneNumber>
      <d2p1:Prefix>sample string 4</d2p1:Prefix>
      <d2p1:SocialSecurityNumber>sample string 8</d2p1:SocialSecurityNumber>
      <d2p1:StateID>sample string 14</d2p1:StateID>
      <d2p1:Suffix>sample string 5</d2p1:Suffix>
      <d2p1:Zip4Code>sample string 16</d2p1:Zip4Code>
      <d2p1:ZipCode>sample string 15</d2p1:ZipCode>
    </d2p1:spGetCompletePeopleRecords>
  </peopleList>
  <responseStatus>Success</responseStatus>
</apiResponsePeople>