GET {version}/Individuals?indGuid={indGuid}
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 |
|
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.IndividualBaseName | 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": "fb1f4b98-d9c3-4f81-a80f-7b60a1056444", "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": "0d5164f6-6813-49d8-91b3-ec0b63a8ff94", "Default": true, "SMSOptIn": true }, { "Number": "sample string 1", "Type": "sample string 2", "Id": "0d5164f6-6813-49d8-91b3-ec0b63a8ff94", "Default": true, "SMSOptIn": true } ], "Addresses": [ { "Id": "d6bb9301-130e-432e-a9a9-965fceaf0bbb", "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": "d6bb9301-130e-432e-a9a9-965fceaf0bbb", "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": "53dd7330-1c3d-49ef-ab78-0c98c208c890", "Email": "sample string 2", "Type": "sample string 3", "Default": true }, { "Id": "53dd7330-1c3d-49ef-ab78-0c98c208c890", "Email": "sample string 2", "Type": "sample string 3", "Default": true } ], "Groups": [ { "Id": "6167128c-abb4-4257-a12b-cad9b47ae146", "egp_Guid": "4df0ad8d-b0a9-478a-8dcb-0a362e9056f4", "GroupName": "sample string 3", "GroupCategory": "sample string 4" }, { "Id": "6167128c-abb4-4257-a12b-cad9b47ae146", "egp_Guid": "4df0ad8d-b0a9-478a-8dcb-0a362e9056f4", "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>d6bb9301-130e-432e-a9a9-965fceaf0bbb</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>d6bb9301-130e-432e-a9a9-965fceaf0bbb</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>fb1f4b98-d9c3-4f81-a80f-7b60a1056444</GUID> <Groups> <Group> <GroupCategory>sample string 4</GroupCategory> <GroupName>sample string 3</GroupName> <Id>6167128c-abb4-4257-a12b-cad9b47ae146</Id> <egp_Guid>4df0ad8d-b0a9-478a-8dcb-0a362e9056f4</egp_Guid> </Group> <Group> <GroupCategory>sample string 4</GroupCategory> <GroupName>sample string 3</GroupName> <Id>6167128c-abb4-4257-a12b-cad9b47ae146</Id> <egp_Guid>4df0ad8d-b0a9-478a-8dcb-0a362e9056f4</egp_Guid> </Group> </Groups> <IndividualeMail> <EmailAddress> <Default>true</Default> <Email>sample string 2</Email> <Id>53dd7330-1c3d-49ef-ab78-0c98c208c890</Id> <Type>sample string 3</Type> </EmailAddress> <EmailAddress> <Default>true</Default> <Email>sample string 2</Email> <Id>53dd7330-1c3d-49ef-ab78-0c98c208c890</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>0d5164f6-6813-49d8-91b3-ec0b63a8ff94</Id> <Number>sample string 1</Number> <SMSOptIn>true</SMSOptIn> <Type>sample string 2</Type> </Phone> <Phone> <Default>true</Default> <Id>0d5164f6-6813-49d8-91b3-ec0b63a8ff94</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>