GET {version}/Individuals?indGuid={indGuid}&includeGroups={includeGroups}
Returns basic information about an individual. Expects a valid Individual Guid as the parameter.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| indGuid | globally unique identifier |
Required |
|
| includeGroups | boolean |
Default value is False |
|
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Returns JSON Object with following properties: Salutation, FirstName, MiddleName, LastName, SourceID, Employer, Phones, Addresses, IndividualeMail, Voter ID
Aristotle.P6.ViewModels.Entity.IndividualBase| Name | Description | Type | Additional information |
|---|---|---|---|
| GUID | globally unique identifier |
Required |
|
| Salutation | string |
Max length: 30 |
|
| Prefix | string |
Max length: 10 |
|
| FirstName | string |
Required Max length: 30 |
|
| MiddleName | string |
Max length: 30 |
|
| LastName | string |
Required Max length: 30 |
|
| SourceID | string |
Required Max length: 50 |
|
| Suffix | string |
Max length: 10 |
|
| VoterId | string |
None. |
|
| Employer | string |
None. |
|
| DefaultCompanyLocationName | string |
None. |
|
| DefaultCompanyLocationSourceId | string |
None. |
|
| Occupation | string |
None. |
|
| Phones | Collection of Aristotle.P6.ViewModels.Entity.Phone |
None. |
|
| Addresses | Collection of Aristotle.P6.ViewModels.Entity.Address |
None. |
|
| IndividualeMail | Collection of Aristotle.P6.ViewModels.Entity.EmailAddress |
None. |
|
| Groups | Collection of Aristotle.P6.ViewModels.Entity.Group |
None. |
Response Formats
application/json, text/json
Sample:
{
"GUID": "7184e559-38a1-413b-9003-94d166fcc720",
"Salutation": "sample string 2",
"Prefix": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"LastName": "sample string 6",
"SourceID": "sample string 7",
"Suffix": "sample string 8",
"VoterId": "sample string 9",
"Employer": "sample string 10",
"DefaultCompanyLocationName": "sample string 11",
"DefaultCompanyLocationSourceId": "sample string 12",
"Occupation": "sample string 13",
"Phones": [
{
"Number": "sample string 1",
"Type": "sample string 2",
"Id": "67af4095-3868-494c-bfe5-bec3c233764c",
"Default": true,
"SMSOptIn": true
},
{
"Number": "sample string 1",
"Type": "sample string 2",
"Id": "67af4095-3868-494c-bfe5-bec3c233764c",
"Default": true,
"SMSOptIn": true
}
],
"Addresses": [
{
"Id": "a66d8199-7fb9-440c-a8c4-efa0dcc83b9c",
"Line1": "sample string 2",
"Line2": "sample string 3",
"Line3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip5": "sample string 7",
"Zip4": "sample string 8",
"Type": "sample string 9",
"Default": true
},
{
"Id": "a66d8199-7fb9-440c-a8c4-efa0dcc83b9c",
"Line1": "sample string 2",
"Line2": "sample string 3",
"Line3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip5": "sample string 7",
"Zip4": "sample string 8",
"Type": "sample string 9",
"Default": true
}
],
"IndividualeMail": [
{
"Id": "40dc8df5-7574-424b-8bef-cdd0f66c4e8c",
"Email": "sample string 2",
"Type": "sample string 3",
"Default": true
},
{
"Id": "40dc8df5-7574-424b-8bef-cdd0f66c4e8c",
"Email": "sample string 2",
"Type": "sample string 3",
"Default": true
}
],
"Groups": [
{
"Id": "39f5f231-1c52-4ecb-bc89-6b29d9e38846",
"egp_Guid": "1846bd01-9e7b-42f8-a8a5-df432f1ecacf",
"GroupName": "sample string 3",
"GroupCategory": "sample string 4"
},
{
"Id": "39f5f231-1c52-4ecb-bc89-6b29d9e38846",
"egp_Guid": "1846bd01-9e7b-42f8-a8a5-df432f1ecacf",
"GroupName": "sample string 3",
"GroupCategory": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
<IndividualBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.P6.ViewModels.Entity">
<Addresses>
<Address>
<City>sample string 5</City>
<Default>true</Default>
<Id>a66d8199-7fb9-440c-a8c4-efa0dcc83b9c</Id>
<Line1>sample string 2</Line1>
<Line2>sample string 3</Line2>
<Line3>sample string 4</Line3>
<State>sample string 6</State>
<Type>sample string 9</Type>
<Zip4>sample string 8</Zip4>
<Zip5>sample string 7</Zip5>
</Address>
<Address>
<City>sample string 5</City>
<Default>true</Default>
<Id>a66d8199-7fb9-440c-a8c4-efa0dcc83b9c</Id>
<Line1>sample string 2</Line1>
<Line2>sample string 3</Line2>
<Line3>sample string 4</Line3>
<State>sample string 6</State>
<Type>sample string 9</Type>
<Zip4>sample string 8</Zip4>
<Zip5>sample string 7</Zip5>
</Address>
</Addresses>
<DefaultCompanyLocationName>sample string 11</DefaultCompanyLocationName>
<DefaultCompanyLocationSourceId>sample string 12</DefaultCompanyLocationSourceId>
<Employer>sample string 10</Employer>
<FirstName>sample string 4</FirstName>
<GUID>7184e559-38a1-413b-9003-94d166fcc720</GUID>
<Groups>
<Group>
<GroupCategory>sample string 4</GroupCategory>
<GroupName>sample string 3</GroupName>
<Id>39f5f231-1c52-4ecb-bc89-6b29d9e38846</Id>
<egp_Guid>1846bd01-9e7b-42f8-a8a5-df432f1ecacf</egp_Guid>
</Group>
<Group>
<GroupCategory>sample string 4</GroupCategory>
<GroupName>sample string 3</GroupName>
<Id>39f5f231-1c52-4ecb-bc89-6b29d9e38846</Id>
<egp_Guid>1846bd01-9e7b-42f8-a8a5-df432f1ecacf</egp_Guid>
</Group>
</Groups>
<IndividualeMail>
<EmailAddress>
<Default>true</Default>
<Email>sample string 2</Email>
<Id>40dc8df5-7574-424b-8bef-cdd0f66c4e8c</Id>
<Type>sample string 3</Type>
</EmailAddress>
<EmailAddress>
<Default>true</Default>
<Email>sample string 2</Email>
<Id>40dc8df5-7574-424b-8bef-cdd0f66c4e8c</Id>
<Type>sample string 3</Type>
</EmailAddress>
</IndividualeMail>
<LastName>sample string 6</LastName>
<MiddleName>sample string 5</MiddleName>
<Occupation>sample string 13</Occupation>
<Phones>
<Phone>
<Default>true</Default>
<Id>67af4095-3868-494c-bfe5-bec3c233764c</Id>
<Number>sample string 1</Number>
<SMSOptIn>true</SMSOptIn>
<Type>sample string 2</Type>
</Phone>
<Phone>
<Default>true</Default>
<Id>67af4095-3868-494c-bfe5-bec3c233764c</Id>
<Number>sample string 1</Number>
<SMSOptIn>true</SMSOptIn>
<Type>sample string 2</Type>
</Phone>
</Phones>
<Prefix>sample string 3</Prefix>
<Salutation>sample string 2</Salutation>
<SourceID>sample string 7</SourceID>
<Suffix>sample string 8</Suffix>
<VoterId>sample string 9</VoterId>
</IndividualBase>